summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-16 16:53:39 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-18 16:15:30 +0200
commit5f613896ee90920baf9fe110faf5c8a4a249a9f9 (patch)
treea011396316510cf4576ad0d81d242ea8f943a32f
parent2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (diff)
downloadpoky-5f613896ee90920baf9fe110faf5c8a4a249a9f9.tar.gz
poky-5f613896ee90920baf9fe110faf5c8a4a249a9f9.tar.bz2
poky-5f613896ee90920baf9fe110faf5c8a4a249a9f9.zip
adt-manual: Scrubbed and fixed user-supplied input formatting.
Throughout the manual I was using angled brackets to denote user-supplied input. This is confusing so I changed to using the <replaceable></replaceable> tag set. (From yocto-docs rev: 79ec3f1b1330539ab2b3bdfb1c94e58c2d0feead) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/adt-manual/adt-command.xml6
-rw-r--r--documentation/adt-manual/adt-package.xml12
-rw-r--r--documentation/adt-manual/adt-prepare.xml18
3 files changed, 18 insertions, 18 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index 9aa25fad40..164b1efbff 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -177,7 +177,7 @@
Thus, the following command works:
<literallayout class='monospaced'>
$ ./configure --host=armv5te-poky-linux-gnueabi \
- --with-libtool-sysroot=&lt;sysroot-dir&gt;
+ --with-libtool-sysroot=<replaceable>sysroot-dir</replaceable>
</literallayout>
</para>
@@ -186,13 +186,13 @@
cross-toolchain tools.
<note>
If the <filename>configure</filename> script results in problems recognizing the
- <filename>--with-libtool-sysroot=&lt;sysroot-dir&gt;</filename> option,
+ <filename>--with-libtool-sysroot=</filename><replaceable>sysroot-dir</replaceable> option,
regenerate the script to enable the support by doing the following and then
run the script again:
<literallayout class='monospaced'>
$ libtoolize --automake
$ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \
- [-I &lt;dir_containing_your_project-specific_m4_macros&gt;]
+ [-I <replaceable>dir_containing_your_project-specific_m4_macros</replaceable>]
$ autoconf
$ autoheader
$ automake -a
diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml
index da032eee5b..5c3196ea91 100644
--- a/documentation/adt-manual/adt-package.xml
+++ b/documentation/adt-manual/adt-package.xml
@@ -80,17 +80,17 @@
Next, source the environment setup script found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Follow that by setting up the installation destination to point to your
- sysroot as <filename>&lt;sysroot_dir&gt;</filename>.
- Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename>
+ sysroot as <replaceable>sysroot_dir</replaceable>.
+ Finally, have an OPKG configuration file <replaceable>conf_file</replaceable>
that corresponds to the <filename>opkg</filename> repository you have just created.
The following command forms should now work:
<literallayout class='monospaced'>
- $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; update
- $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \
+ $ opkg-cl –f <replaceable>conf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> update
+ $ opkg-cl –f <replaceable>cconf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> \
--force-overwrite install libglade
- $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \
+ $ opkg-cl –f <replaceable>cconf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> \
--force-overwrite install libglade-dbg
- $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; \
+ $ opkg-cl –f <replaceable>conf_file&gt; -o </replaceable>sysroot_dir&gt; \
--force-overwrite install libglade-dev
</literallayout>
</para>
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 89ef09fb24..7faf39b9e2 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -183,20 +183,20 @@
Please make sure you understand the security implications of doing this.
You might also have to modify your firewall settings to allow
NFS booting to work.</note></para></listitem>
- <listitem><para><filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>: The root
+ <listitem><para><filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>: The root
filesystem images you want to download from the
<filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem>
- <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_&lt;arch&gt;</filename>: The
+ <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_</filename><replaceable>arch</replaceable>: The
particular root filesystem used to extract and create the target sysroot.
The value of this variable must have been specified with
- <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>.
+ <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>.
For example, if you downloaded both <filename>minimal</filename> and
<filename>sato-sdk</filename> images by setting
- <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>
- to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>
+ <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
+ to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
must be set to either "minimal" or "sato-sdk".
</para></listitem>
- <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>: The
+ <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_</filename><replaceable>arch</replaceable>: The
location on the development host where the target sysroot is created.
</para></listitem>
</itemizedlist>
@@ -212,7 +212,7 @@
Once the installer begins to run, you are asked to enter the
location for cross-toolchain installation.
The default location is
- <filename>/opt/poky/&lt;release&gt;</filename>.
+ <filename>/opt/poky/</filename><replaceable>release</replaceable>.
After either accepting the default location or selecting your
own location, you are prompted to run the installation script
interactively or in silent mode.
@@ -230,7 +230,7 @@
<filename>adt-installer</filename> directory according to your
installer configurations, and the target sysroot located
according to the
- <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>
+ <filename>YOCTOADT_TARGET_SYSROOT_LOC_</filename><replaceable>arch</replaceable>
variable also in your configuration file.
</para>
</section>
@@ -593,7 +593,7 @@
section.
</para></listitem>
<listitem><para>
- Use <filename>bitbake &lt;image&gt; -c populate_sdk</filename>.
+ Use <filename>bitbake</filename> <replaceable>image</replaceable> <filename>-c populate_sdk</filename>.
This method has significant advantages over the previous method
because it results in a toolchain installer that contains the
sysroot that matches your target root filesystem.