path: root/documentation/ref-manual/migration.xml
diff options
authorScott Rifenbark <>2014-10-16 16:31:19 -0700
committerRichard Purdie <>2014-10-18 16:15:30 +0200
commit2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (patch)
treeace8abdef240fafd3bdbeed9001e67da40d7cbd8 /documentation/ref-manual/migration.xml
parentb96378eb6b2443301b04dfc83eecf36eced6a27c (diff)
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 <> Signed-off-by: Richard Purdie <>
Diffstat (limited to 'documentation/ref-manual/migration.xml')
1 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index f8bd852ad8..0e297b582a 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -110,7 +110,7 @@
appended to the path used to access the mirror.
Here is an example:
<literallayout class='monospaced'>
- SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH"
+ SSTATE_MIRRORS = "file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH"
@@ -375,10 +375,11 @@
<listitem><para><emphasis>Shared State Code:</emphasis>
The shared state code has been optimized to avoid running
unnecessary tasks.
- For example,
- <filename>bitbake -c rootfs some-image</filename> from
- shared state no longer populates the target sysroot
- since that is not necessary.
+ For example, the following no longer populates the target
+ sysroot since that is not necessary:
+ <literallayout class='monospaced'>
+ $ bitbake -c rootfs <replaceable>some-image</replaceable>
+ </literallayout>
Instead, the system just needs to extract the output
package contents, re-create the packages, and construct
the root filesystem.
@@ -832,7 +833,7 @@
This directory is located under
<filename>sysroots</filename> and uses a machine-specific
name (i.e.
- <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>).
+ <filename>tmp/sysroots/<replaceable>machine</replaceable>/pkgdata</filename>).
@@ -1100,7 +1101,7 @@
<filename>base-files</filename>: Remove the unnecessary
- <filename>media/xxx</filename> directories.
+ <filename>media/</filename><replaceable>xxx</replaceable> directories.
<filename>alsa-state</filename>: Provide an empty
@@ -1228,7 +1229,7 @@
value against the branch.
You can specify the branch using the following form:
<literallayout class='monospaced'>
- SRC_URI = "git://;branch=&lt;branchname&gt;"
+ SRC_URI = "git://;branch=<replaceable>branchname</replaceable>"
If you do not specify a branch, BitBake looks
in the default "master" branch.
@@ -1305,10 +1306,10 @@
<section id='migration-1.6-task-taskname-overrides'>
- <title><filename>task-&lt;taskname&gt;</filename> Overrides</title>
+ <title><filename>task-</filename><replaceable>taskname</replaceable> Overrides</title>
- <filename>task-&lt;taskname&gt;</filename> overrides have been
+ <filename>task-</filename><replaceable>taskname</replaceable> overrides have been
adjusted so that tasks whose names contain underscores have the
underscores replaced by hyphens for the override so that they
now function properly.
@@ -1932,8 +1933,8 @@
Package QA checks are now performed during a new
- <filename>do_package_qa</filename> task rather
- than being part of the
+ <link linkend='ref-tasks-package_qa'><filename>do_package_qa</filename></link>
+ task rather than being part of the
<link linkend='ref-tasks-package'><filename>do_package</filename></link>
This allows more parallel execution.