`docs/modules/how-barectf-works/pages/index.adoc`:
- Facilitate understanding for beginners (Make sentence structure
more explicit, Use more explicit terms)
`docs/modules/platform/pages/index.adoc`:
- "recommandation" --> "recommendation"
- Remove "as its document"
Change-Id: I00e123a348cb90b53aed5effcde7f9ecdbbae453
Signed-off-by: Erica Bugden <ebugden@efficios.com>
generated <<metadata,CTF metadata stream>> form a complete
xref:ctf-primer.adoc#trace[CTF trace].
generated <<metadata,CTF metadata stream>> form a complete
xref:ctf-primer.adoc#trace[CTF trace].
-How exactly the event timestamps are sourced and the CTF packets are
-appended to some file or memory buffer is controlled by the
-xref:platform:index.adoc[**platform**].
+The specifics of how the event timestamps are sampled and how the CTF
+packets are appended to some file (or memory buffer) is controlled by
+the xref:platform:index.adoc[**platform**].
See xref:example.adoc[] for a complete barectf platform example.
See xref:example.adoc[] for a complete barectf platform example.
-== YAML configuration file recommandation
+== YAML configuration file recommendation
The barectf project recommends that you create a
partial YAML file containing a base xref:yaml:trace-type-obj.adoc[trace
The barectf project recommends that you create a
partial YAML file containing a base xref:yaml:trace-type-obj.adoc[trace
-type object] as its document for your platform.
+type object] for your platform.
This platform's base trace type object can be configured so that it
matches what your platform expects, for example:
This platform's base trace type object can be configured so that it
matches what your platform expects, for example: