docs: cleanup: Rephrase and correct typos

`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>

diff --git a/docs/modules/how-barectf-works/pages/index.adoc b/docs/modules/how-barectf-works/pages/index.adoc
index 124e9852d104b83f6aa170642be2215805400aea..89b444ee1f0ee3c8628f21709f09fe42fe51ae9c 100644 (file)
--- a/docs/modules/how-barectf-works/pages/index.adoc
+++ b/docs/modules/how-barectf-works/pages/index.adoc
@@ -71,9 +71,9 @@ xref:ctf-primer.adoc#pkt[packets]. Those CTF data streams and the
 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**].
 
 == Data flow
 

diff --git a/docs/modules/platform/pages/index.adoc b/docs/modules/platform/pages/index.adoc
index e1ba8669a55e61e4295e9fded24919bb965fcaf4..b724a163f5490afc013c01948a91d06cb6a98044 100644 (file)
--- a/docs/modules/platform/pages/index.adoc
+++ b/docs/modules/platform/pages/index.adoc
@@ -83,11 +83,11 @@ returns the requested barectf context pointer.
 
 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
-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: