diff options
| author | Bartosz Nitka <niteria@gmail.com> | 2017-05-08 06:26:12 -0700 |
|---|---|---|
| committer | Bartosz Nitka <niteria@gmail.com> | 2017-05-08 06:26:17 -0700 |
| commit | c685a44776ca77cad813f32e3cc7f7a42daf1d7d (patch) | |
| tree | 2bbd191a0c46746bdbea69c3f9f7caa5319664a3 /docs/users_guide/eventlog-formats.rst | |
| parent | 579749d4c74b75d8f5df83234414b92950aca64b (diff) | |
| download | haskell-c685a44776ca77cad813f32e3cc7f7a42daf1d7d.tar.gz | |
[Docs] Prefer cost centre
There may be some subtlety I'm not seeing with the usage
of center vs centre. Otherwise this makes it more consistent
in the docs.
There's one instance in 8.0.2-notes.rst, but I'm not sure if
we want to modify it retroactively.
Test Plan: harbormaster?
Reviewers: bgamari, austin
Reviewed By: bgamari
Subscribers: rwbarton, thomie, simonmar
Differential Revision: https://phabricator.haskell.org/D3548
Diffstat (limited to 'docs/users_guide/eventlog-formats.rst')
| -rw-r--r-- | docs/users_guide/eventlog-formats.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst index 8d53f92323..f7eb1ca449 100644 --- a/docs/users_guide/eventlog-formats.rst +++ b/docs/users_guide/eventlog-formats.rst @@ -46,24 +46,24 @@ A single fixed-width event emitted during program start-up describing the sample * ``String``: Retainer filter * ``String``: Biography filter -Cost center definitions +Cost centre definitions ^^^^^^^^^^^^^^^^^^^^^^^ -A variable-length packet produced once for each cost center, +A variable-length packet produced once for each cost centre, * ``EVENT_HEAP_PROF_COST_CENTRE`` - * ``Word32``: cost center number + * ``Word32``: cost centre number * ``String``: label * ``String``: module * ``String``: source location * ``Word8``: flags - * bit 0: is the cost-center a CAF? + * bit 0: is the cost-centre a CAF? Sample event types ~~~~~~~~~~~~~~~~~~ -A sample (consisting of a list of break-down classes, e.g. cost centers, and +A sample (consisting of a list of break-down classes, e.g. cost centres, and heap residency sizes), is to be encoded in the body of one or more events. We mark the beginning of a new sample with an ``EVENT_HEAP_PROF_SAMPLE_BEGIN`` @@ -78,17 +78,17 @@ in length a single sample may need to be split among multiple determined by the break-down type. -Cost-center break-down +Cost-centre break-down ^^^^^^^^^^^^^^^^^^^^^^ A variable-length packet encoding a heap profile sample broken down by, - * cost-center (``-hc``) + * cost-centre (``-hc``) * ``EVENT_HEAP_PROF_SAMPLE_COST_CENTRE`` * ``Word8``: Profile ID * ``Word64``: heap residency in bytes * ``Word8``: stack depth - * ``Word32[]``: cost center stack starting with inner-most (cost center numbers) + * ``Word32[]``: cost centre stack starting with inner-most (cost centre numbers) String break-down |