sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2014-10-16 16:53:39 -07:00 committed by Richard Purdie
parent 2eaf7e6e75
commit 5f613896ee
3 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/adt-manual/adt-command.xml
View File

@ -177,7 +177,7 @@
Thus, the following command works: Thus, the following command works:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ ./configure --host=armv5te-poky-linux-gnueabi \ $ ./configure --host=armv5te-poky-linux-gnueabi \
--with-libtool-sysroot=&lt;sysroot-dir&gt; --with-libtool-sysroot=<replaceable>sysroot-dir</replaceable>
</literallayout> </literallayout>
</para> </para>
@ -186,13 +186,13 @@
cross-toolchain tools. cross-toolchain tools.
<note> <note>
If the <filename>configure</filename> script results in problems recognizing the 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 regenerate the script to enable the support by doing the following and then
run the script again: run the script again:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ libtoolize --automake $ libtoolize --automake
$ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \ $ 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 $ autoconf
$ autoheader $ autoheader
$ automake -a $ automake -a

12
documentation/adt-manual/adt-package.xml
View File

@ -80,17 +80,17 @@
Next, source the environment setup script found in the Next, source the environment setup script found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Follow that by setting up the installation destination to point to your Follow that by setting up the installation destination to point to your
sysroot as <filename>&lt;sysroot_dir&gt;</filename>. sysroot as <replaceable>sysroot_dir</replaceable>.
Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename> Finally, have an OPKG configuration file <replaceable>conf_file</replaceable>
that corresponds to the <filename>opkg</filename> repository you have just created. that corresponds to the <filename>opkg</filename> repository you have just created.
The following command forms should now work: The following command forms should now work:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; update $ opkg-cl –f <replaceable>conf_file</replaceable> -o <replaceable>sysroot_dir</replaceable> update
$ 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 --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 --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 --force-overwrite install libglade-dev
</literallayout> </literallayout>
</para> </para>

18
documentation/adt-manual/adt-prepare.xml
View File

@ -183,20 +183,20 @@
Please make sure you understand the security implications of doing this. Please make sure you understand the security implications of doing this.
You might also have to modify your firewall settings to allow You might also have to modify your firewall settings to allow
NFS booting to work.</note></para></listitem> 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 filesystem images you want to download from the
<filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem> <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. particular root filesystem used to extract and create the target sysroot.
The value of this variable must have been specified with 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 For example, if you downloaded both <filename>minimal</filename> and
<filename>sato-sdk</filename> images by setting <filename>sato-sdk</filename> images by setting
<filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename> <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename> to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_</filename><replaceable>arch</replaceable>
must be set to either "minimal" or "sato-sdk". must be set to either "minimal" or "sato-sdk".
</para></listitem> </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. location on the development host where the target sysroot is created.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
@ -212,7 +212,7 @@
Once the installer begins to run, you are asked to enter the Once the installer begins to run, you are asked to enter the
location for cross-toolchain installation. location for cross-toolchain installation.
The default location is 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 After either accepting the default location or selecting your
own location, you are prompted to run the installation script own location, you are prompted to run the installation script
interactively or in silent mode. interactively or in silent mode.
@ -230,7 +230,7 @@
<filename>adt-installer</filename> directory according to your <filename>adt-installer</filename> directory according to your
installer configurations, and the target sysroot located installer configurations, and the target sysroot located
according to the 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. variable also in your configuration file.
</para> </para>
</section> </section>
@ -593,7 +593,7 @@
section. section.
</para></listitem> </para></listitem>
<listitem><para> <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 This method has significant advantages over the previous method
because it results in a toolchain installer that contains the because it results in a toolchain installer that contains the
sysroot that matches your target root filesystem. sysroot that matches your target root filesystem.