diff options
| author | Jose Fonseca <jfonseca@vmware.com> | 2016-10-05 22:32:47 +0100 |
|---|---|---|
| committer | Jose Fonseca <jfonseca@vmware.com> | 2016-10-05 22:34:55 +0100 |
| commit | b5ce01582154680b4d5064751afbf2dc5a47f42b (patch) | |
| tree | ec89a631248a28db2f3b36ce24d70bc0459b7642 | |
| parent | 0c85d0b2483f996d18b796fafa92bb39aa8a466f (diff) | |
docs: Fix discrepancy and ambiguity in format spec.
As pointed out by [bk]door.maus in issue #492.
Also fix some spelling errors.
| -rw-r--r-- | docs/FORMAT.markdown | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/FORMAT.markdown b/docs/FORMAT.markdown index f23323aa..9c7aeff5 100644 --- a/docs/FORMAT.markdown +++ b/docs/FORMAT.markdown @@ -9,7 +9,7 @@ to be compressed with gzip. ## Versions ## -We keep backwards compatability reading old traces, i.e., it should always be +We keep backwards compatibility reading old traces, i.e., it should always be possible to parse and retrace old trace files. The trace version number refers not only to changes in the binary format @@ -26,7 +26,7 @@ be retraced. | 5 | support for call backtraces | Writing/editing old traces is not supported however. An older version of -apitrace should be used in such circunstances. +apitrace should be used in such circumstances. ## Basic types ## @@ -34,7 +34,7 @@ apitrace should be used in such circunstances. | Type | Description | | ---- | ----------- | | `byte` | Raw byte. | -| `uint` | Variable-length unsigned integer, where the most significative bit is zero for last byte or non-zero if more bytes follow; the 7 least significant bits of each byte are used for the integer's bits, in little-endian order. | +| `uint` | Variable-length unsigned integer, where the most significant bit is zero for last byte or non-zero if more bytes follow; the 7 least significant bits of each byte are used for the integer's bits, in little-endian order. | | `float` | 32 bits single precision floating point number | | `double` | 64 bits single precision floating point number | @@ -104,13 +104,14 @@ and the call number is implied for the enter event. enum_sig = id count (name value)+ // first occurrence | id // follow-on occurrences - bitmask_sig = id count (name value)+ // first occurrence - | id // follow-on occurrences + bitmask_sig = id count (name uint)+ // first occurrence + | id // follow-on occurrences - struct_sig = id count member_name* // first occurrence - | id // follow-on occurrences + struct_sig = id struct_name count member_name* // first occurrence + | id // follow-on occurrences name = string + struct_name = string member_name = string wstring = count uint* |