diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-10-16 16:31:19 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-10-18 16:15:30 +0200 |
commit | 2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (patch) | |
tree | ace8abdef240fafd3bdbeed9001e67da40d7cbd8 /documentation/ref-manual/ref-structure.xml | |
parent | b96378eb6b2443301b04dfc83eecf36eced6a27c (diff) | |
download | poky-2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b.tar.gz |
ref-manual: Scrubbed for variable (user) input.
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index eb1be38701..14419d3a84 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -315,7 +315,7 @@ | |||
315 | commands. | 315 | commands. |
316 | Following is the script syntax: | 316 | Following is the script syntax: |
317 | <literallayout class='monospaced'> | 317 | <literallayout class='monospaced'> |
318 | $ source oe-init-build-env-memres <port_number> <build_dir> | 318 | $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable> |
319 | </literallayout> | 319 | </literallayout> |
320 | The script uses other scripts within the | 320 | The script uses other scripts within the |
321 | <filename>scripts</filename> directory to do the bulk of the work. | 321 | <filename>scripts</filename> directory to do the bulk of the work. |
@@ -499,7 +499,7 @@ | |||
499 | the variable in the top-level build environment setup script as | 499 | the variable in the top-level build environment setup script as |
500 | follows: | 500 | follows: |
501 | <literallayout class='monospaced'> | 501 | <literallayout class='monospaced'> |
502 | TEMPLATECONF=<your_layer>/conf | 502 | TEMPLATECONF=<replaceable>your_layer</replaceable>/conf |
503 | </literallayout> | 503 | </literallayout> |
504 | Once the build process gets the sample file, it uses | 504 | Once the build process gets the sample file, it uses |
505 | <filename>sed</filename> to substitute final | 505 | <filename>sed</filename> to substitute final |
@@ -554,7 +554,7 @@ | |||
554 | you can base your build from any layer by setting the variable in | 554 | you can base your build from any layer by setting the variable in |
555 | the top-level build environment setup script as follows: | 555 | the top-level build environment setup script as follows: |
556 | <literallayout class='monospaced'> | 556 | <literallayout class='monospaced'> |
557 | TEMPLATECONF=<your_layer>/conf | 557 | TEMPLATECONF=<replaceable>your_layer</replaceable>/conf |
558 | </literallayout> | 558 | </literallayout> |
559 | Once the build process gets the sample file, it uses | 559 | Once the build process gets the sample file, it uses |
560 | <filename>sed</filename> to substitute final | 560 | <filename>sed</filename> to substitute final |