summaryrefslogtreecommitdiffstats
path: root/documentation
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 /documentation
parent2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (diff)
downloadpoky-5f613896ee90920baf9fe110faf5c8a4a249a9f9.tar.gz
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>
Diffstat (limited to 'documentation')
-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 @@
177 Thus, the following command works: 177 Thus, the following command works:
178 <literallayout class='monospaced'> 178 <literallayout class='monospaced'>
179 $ ./configure --host=armv5te-poky-linux-gnueabi \ 179 $ ./configure --host=armv5te-poky-linux-gnueabi \
180 --with-libtool-sysroot=&lt;sysroot-dir&gt; 180 --with-libtool-sysroot=<replaceable>sysroot-dir</replaceable>
181 </literallayout> 181 </literallayout>
182 </para> 182 </para>
183 183
@@ -186,13 +186,13 @@
186 cross-toolchain tools. 186 cross-toolchain tools.
187 <note> 187 <note>
188 If the <filename>configure</filename> script results in problems recognizing the 188 If the <filename>configure</filename> script results in problems recognizing the
189 <filename>--with-libtool-sysroot=&lt;sysroot-dir&gt;</filename> option, 189 <filename>--with-libtool-sysroot=</filename><replaceable>sysroot-dir</replaceable> option,
190 regenerate the script to enable the support by doing the following and then 190 regenerate the script to enable the support by doing the following and then
191 run the script again: 191 run the script again:
192 <literallayout class='monospaced'> 192 <literallayout class='monospaced'>
193 $ libtoolize --automake 193 $ libtoolize --automake
194 $ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \ 194 $ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \
195 [-I &lt;dir_containing_your_project-specific_m4_macros&gt;] 195 [-I <replaceable>dir_containing_your_project-specific_m4_macros</replaceable>]
196 $ autoconf 196 $ autoconf
197 $ autoheader 197 $ autoheader
198 $ automake -a 198 $ 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 @@
80 Next, source the environment setup script found in the 80 Next, source the environment setup script found in the
81 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 81 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
82 Follow that by setting up the installation destination to point to your 82 Follow that by setting up the installation destination to point to your
83 sysroot as <filename>&lt;sysroot_dir&gt;</filename>. 83 sysroot as <replaceable>sysroot_dir</replaceable>.
84 Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename> 84 Finally, have an OPKG configuration file <replaceable>conf_file</replaceable>
85 that corresponds to the <filename>opkg</filename> repository you have just created. 85 that corresponds to the <filename>opkg</filename> repository you have just created.
86 The following command forms should now work: 86 The following command forms should now work:
87 <literallayout class='monospaced'> 87 <literallayout class='monospaced'>
88 $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; update 88 $ opkg-cl –f <replaceable>conf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> update
89 $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \ 89 $ opkg-cl –f <replaceable>cconf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> \
90 --force-overwrite install libglade 90 --force-overwrite install libglade
91 $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \ 91 $ opkg-cl –f <replaceable>cconf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> \
92 --force-overwrite install libglade-dbg 92 --force-overwrite install libglade-dbg
93 $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; \ 93 $ opkg-cl –f <replaceable>conf_file&gt; -o </replaceable>sysroot_dir&gt; \
94 --force-overwrite install libglade-dev 94 --force-overwrite install libglade-dev
95 </literallayout> 95 </literallayout>
96 </para> 96 </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 @@
183 Please make sure you understand the security implications of doing this. 183 Please make sure you understand the security implications of doing this.
184 You might also have to modify your firewall settings to allow 184 You might also have to modify your firewall settings to allow
185 NFS booting to work.</note></para></listitem> 185 NFS booting to work.</note></para></listitem>
186 <listitem><para><filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>: The root 186 <listitem><para><filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>: The root
187 filesystem images you want to download from the 187 filesystem images you want to download from the
188 <filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem> 188 <filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem>
189 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_&lt;arch&gt;</filename>: The 189 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_</filename><replaceable>arch</replaceable>: The
190 particular root filesystem used to extract and create the target sysroot. 190 particular root filesystem used to extract and create the target sysroot.
191 The value of this variable must have been specified with 191 The value of this variable must have been specified with
192 <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>. 192 <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>.
193 For example, if you downloaded both <filename>minimal</filename> and 193 For example, if you downloaded both <filename>minimal</filename> and
194 <filename>sato-sdk</filename> images by setting 194 <filename>sato-sdk</filename> images by setting
195 <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename> 195 <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
196 to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename> 196 to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
197 must be set to either "minimal" or "sato-sdk". 197 must be set to either "minimal" or "sato-sdk".
198 </para></listitem> 198 </para></listitem>
199 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>: The 199 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_</filename><replaceable>arch</replaceable>: The
200 location on the development host where the target sysroot is created. 200 location on the development host where the target sysroot is created.
201 </para></listitem> 201 </para></listitem>
202 </itemizedlist> 202 </itemizedlist>
@@ -212,7 +212,7 @@
212 Once the installer begins to run, you are asked to enter the 212 Once the installer begins to run, you are asked to enter the
213 location for cross-toolchain installation. 213 location for cross-toolchain installation.
214 The default location is 214 The default location is
215 <filename>/opt/poky/&lt;release&gt;</filename>. 215 <filename>/opt/poky/</filename><replaceable>release</replaceable>.
216 After either accepting the default location or selecting your 216 After either accepting the default location or selecting your
217 own location, you are prompted to run the installation script 217 own location, you are prompted to run the installation script
218 interactively or in silent mode. 218 interactively or in silent mode.
@@ -230,7 +230,7 @@
230 <filename>adt-installer</filename> directory according to your 230 <filename>adt-installer</filename> directory according to your
231 installer configurations, and the target sysroot located 231 installer configurations, and the target sysroot located
232 according to the 232 according to the
233 <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename> 233 <filename>YOCTOADT_TARGET_SYSROOT_LOC_</filename><replaceable>arch</replaceable>
234 variable also in your configuration file. 234 variable also in your configuration file.
235 </para> 235 </para>
236 </section> 236 </section>
@@ -593,7 +593,7 @@
593 section. 593 section.
594 </para></listitem> 594 </para></listitem>
595 <listitem><para> 595 <listitem><para>
596 Use <filename>bitbake &lt;image&gt; -c populate_sdk</filename>. 596 Use <filename>bitbake</filename> <replaceable>image</replaceable> <filename>-c populate_sdk</filename>.
597 This method has significant advantages over the previous method 597 This method has significant advantages over the previous method
598 because it results in a toolchain installer that contains the 598 because it results in a toolchain installer that contains the
599 sysroot that matches your target root filesystem. 599 sysroot that matches your target root filesystem.