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

dev-manual, ref-manual: Replaced ‐‐ with "--" 

Fixes [YOCTO #7386]

Apparently, copying HTML displayed commands that have a
double dash created through "‐‐" in the docbook source
causes some issues in the shell.  I have scrubbed the manual set
to replace any "‐‐" strings with "--".

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64)

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 2015-03-04 08:55:54 -08:00 committed by Richard Purdie
parent a889cc011c
commit c504276d26
4 changed files with 92 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

126
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -741,13 +741,13 @@
... ...
DESCRIPTION = "A useful utility" DESCRIPTION = "A useful utility"
... ...
EXTRA_OECONF = "&dash;&dash;enable-something" EXTRA_OECONF = "--enable-something"
... ...
#### bbappended from meta-anotherlayer #### #### bbappended from meta-anotherlayer ####
DESCRIPTION = "Customized utility" DESCRIPTION = "Customized utility"
EXTRA_OECONF += "&dash;&dash;enable-somethingelse" EXTRA_OECONF += "--enable-somethingelse"
</literallayout> </literallayout>
Ideally, you would tidy up these utilities as Ideally, you would tidy up these utilities as
follows: follows:
@ -755,7 +755,7 @@
... ...
DESCRIPTION = "Customized utility" DESCRIPTION = "Customized utility"
... ...
EXTRA_OECONF = "&dash;&dash;enable-something &dash;&dash;enable-somethingelse" EXTRA_OECONF = "--enable-something --enable-somethingelse"
... ...
</literallayout></para></listitem> </literallayout></para></listitem>
</itemizedlist></para></listitem> </itemizedlist></para></listitem>
@ -2275,7 +2275,7 @@
configure script with the appropriate options.</para> configure script with the appropriate options.</para>
<para>For the case involving a custom configure <para>For the case involving a custom configure
script, you would run script, you would run
<filename>./configure &dash;&dash;help</filename> and look for <filename>./configure --help</filename> and look for
the options you need to set.</para></listitem> the options you need to set.</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -2298,7 +2298,7 @@
configure script as needed. configure script as needed.
For reference information on configure options specific to the For reference information on configure options specific to the
software you are building, you can consult the output of the software you are building, you can consult the output of the
<filename>./configure &dash;&dash;help</filename> command within <filename>./configure --help</filename> command within
<filename>${S}</filename> or consult the software's upstream <filename>${S}</filename> or consult the software's upstream
documentation. documentation.
</para> </para>
@ -3780,7 +3780,7 @@
or by entering the command with a help argument as follows: or by entering the command with a help argument as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ wic -h $ wic -h
$ wic &dash;&dash;help $ wic --help
</literallayout> </literallayout>
</para> </para>
@ -3796,7 +3796,7 @@
<para> <para>
You can also get detailed help on a number of topics You can also get detailed help on a number of topics
from the help system. from the help system.
The output of <filename>wic &dash;&dash;help</filename> The output of <filename>wic --help</filename>
displays a list of available help displays a list of available help
topics under a "Help topics" heading. topics under a "Help topics" heading.
You can have the help system display the help text for You can have the help system display the help text for
@ -3866,38 +3866,38 @@
your own custom file or use a file from a set of your own custom file or use a file from a set of
existing files as described by further options. existing files as described by further options.
-o <replaceable>OUTDIR</replaceable>, &dash;&dash;outdir=<replaceable>OUTDIR</replaceable> -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable>
The name of a directory in which to create image. The name of a directory in which to create image.
-i <replaceable>PROPERTIES_FILE</replaceable>, &dash;&dash;infile=<replaceable>PROPERTIES_FILE</replaceable> -i <replaceable>PROPERTIES_FILE</replaceable>, --infile=<replaceable>PROPERTIES_FILE</replaceable>
The name of a file containing the values for image The name of a file containing the values for image
properties as a JSON file. properties as a JSON file.
-e <replaceable>IMAGE_NAME</replaceable>, &dash;&dash;image-name=<replaceable>IMAGE_NAME</replaceable> -e <replaceable>IMAGE_NAME</replaceable>, --image-name=<replaceable>IMAGE_NAME</replaceable>
The name of the image from which to use the artifacts The name of the image from which to use the artifacts
(e.g. <filename>core-image-sato</filename>). (e.g. <filename>core-image-sato</filename>).
-r <replaceable>ROOTFS_DIR</replaceable>, &dash;&dash;rootfs-dir=<replaceable>ROOTFS_DIR</replaceable> -r <replaceable>ROOTFS_DIR</replaceable>, --rootfs-dir=<replaceable>ROOTFS_DIR</replaceable>
The path to the <filename>/rootfs</filename> directory to use as the The path to the <filename>/rootfs</filename> directory to use as the
<filename>.wks</filename> rootfs source. <filename>.wks</filename> rootfs source.
-b <replaceable>BOOTIMG_DIR</replaceable>, &dash;&dash;bootimg-dir=<replaceable>BOOTIMG_DIR</replaceable> -b <replaceable>BOOTIMG_DIR</replaceable>, --bootimg-dir=<replaceable>BOOTIMG_DIR</replaceable>
The path to the directory containing the boot artifacts The path to the directory containing the boot artifacts
(e.g. <filename>/EFI</filename> or <filename>/syslinux</filename>) to use as the <filename>.wks</filename> bootimg (e.g. <filename>/EFI</filename> or <filename>/syslinux</filename>) to use as the <filename>.wks</filename> bootimg
source. source.
-k <replaceable>KERNEL_DIR</replaceable>, &dash;&dash;kernel-dir=<replaceable>KERNEL_DIR</replaceable> -k <replaceable>KERNEL_DIR</replaceable>, --kernel-dir=<replaceable>KERNEL_DIR</replaceable>
The path to the directory containing the kernel to use The path to the directory containing the kernel to use
in the <filename>.wks</filename> boot image. in the <filename>.wks</filename> boot image.
-n <replaceable>NATIVE_SYSROOT</replaceable>, &dash;&dash;native-sysroot=<replaceable>NATIVE_SYSROOT</replaceable> -n <replaceable>NATIVE_SYSROOT</replaceable>, --native-sysroot=<replaceable>NATIVE_SYSROOT</replaceable>
The path to the native sysroot containing the tools to use The path to the native sysroot containing the tools to use
to build the image. to build the image.
-s, &dash;&dash;skip-build-check -s, --skip-build-check
Skips the build check. Skips the build check.
-D, &dash;&dash;debug -D, --debug
Output debug information. Output debug information.
</literallayout> </literallayout>
<note> <note>
@ -4107,13 +4107,13 @@
</literallayout> </literallayout>
Next, the example modifies the Next, the example modifies the
<filename>directdisksdb.wks</filename> file and changes all <filename>directdisksdb.wks</filename> file and changes all
instances of "<filename>&dash;&dash;ondisk sda</filename>" instances of "<filename>--ondisk sda</filename>"
to "<filename>&dash;&dash;ondisk sdb</filename>". to "<filename>--ondisk sdb</filename>".
The example changes the following two lines and leaves the The example changes the following two lines and leaves the
remaining lines untouched: remaining lines untouched:
<literallayout class='monospaced'> <literallayout class='monospaced'>
part /boot &dash;&dash;source bootimg-pcbios &dash;&dash;ondisk sdb &dash;&dash;label boot &dash;&dash;active &dash;&dash;align 1024 part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024
part / &dash;&dash;source rootfs &dash;&dash;ondisk sdb &dash;&dash;fstype=ext3 &dash;&dash;label platform &dash;&dash;align 1024 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
</literallayout> </literallayout>
Once the lines are changed, the example generates the Once the lines are changed, the example generates the
<filename>directdisksdb</filename> image. <filename>directdisksdb</filename> image.
@ -4200,11 +4200,11 @@
somewhere other than the default somewhere other than the default
<filename>/var/tmp/wic</filename> directory: <filename>/var/tmp/wic</filename> directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ wic create ~/test.wks -o /home/trz/testwic &dash;&dash;rootfs-dir \ $ wic create ~/test.wks -o /home/trz/testwic --rootfs-dir \
/home/trz/yocto/yocto-image/build/tmp/work/crownbay_noemgd-poky-linux/core-image-minimal/1.0-r0/rootfs \ /home/trz/yocto/yocto-image/build/tmp/work/crownbay_noemgd-poky-linux/core-image-minimal/1.0-r0/rootfs \
&dash;&dash;bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \ --bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \
&dash;&dash;kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \ --kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \
&dash;&dash;native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux --native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux
Creating image(s)... Creating image(s)...
@ -4247,7 +4247,7 @@
partitions. partitions.
The plugins provide a mechanism for mapping values The plugins provide a mechanism for mapping values
specified in <filename>.wks</filename> files using the specified in <filename>.wks</filename> files using the
<filename>&dash;&dash;source</filename> keyword to a <filename>--source</filename> keyword to a
particular plugin implementation that populates a particular plugin implementation that populates a
corresponding partition. corresponding partition.
</para> </para>
@ -4276,11 +4276,11 @@
When the <filename>wic</filename> implementation needs When the <filename>wic</filename> implementation needs
to invoke a partition-specific implementation, it looks to invoke a partition-specific implementation, it looks
for the plugin that has the same name as the for the plugin that has the same name as the
<filename>&dash;&dash;source</filename> parameter given to <filename>--source</filename> parameter given to
that partition. that partition.
For example, if the partition is set up as follows: For example, if the partition is set up as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
part /boot &dash;&dash;source bootimg-pcbios ... part /boot --source bootimg-pcbios ...
</literallayout> </literallayout>
The methods defined as class members of the plugin The methods defined as class members of the plugin
having the matching <filename>bootimg-pcbios.name</filename> having the matching <filename>bootimg-pcbios.name</filename>
@ -4290,7 +4290,7 @@
<para> <para>
To be more concrete, here is the plugin definition that To be more concrete, here is the plugin definition that
matches a matches a
<filename>&dash;&dash;source bootimg-pcbios</filename> usage, <filename>--source bootimg-pcbios</filename> usage,
along with an example along with an example
method called by the <filename>wic</filename> implementation method called by the <filename>wic</filename> implementation
when it needs to invoke an implementation-specific when it needs to invoke an implementation-specific
@ -4312,7 +4312,7 @@
The <filename>SourcePlugin</filename> class defines the The <filename>SourcePlugin</filename> class defines the
following methods, which is the current set of methods following methods, which is the current set of methods
that can be implemented or overridden by that can be implemented or overridden by
<filename>&dash;&dash;source</filename> plugins. <filename>--source</filename> plugins.
Any methods not implemented by a Any methods not implemented by a
<filename>SourcePlugin</filename> subclass inherit the <filename>SourcePlugin</filename> subclass inherit the
implementations present in the implementations present in the
@ -4444,13 +4444,13 @@
<para> <para>
Following are the supported options: Following are the supported options:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis><filename>&dash;&dash;size</filename>:</emphasis> <listitem><para><emphasis><filename>--size</filename>:</emphasis>
The minimum partition size in MBytes. The minimum partition size in MBytes.
Specify an integer value such as 500. Specify an integer value such as 500.
Do not append the number with "MB". Do not append the number with "MB".
You do not need this option if you use You do not need this option if you use
<filename>&dash;&dash;source</filename>.</para></listitem> <filename>--source</filename>.</para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;source</filename>:</emphasis> <listitem><para><emphasis><filename>--source</filename>:</emphasis>
This option is a This option is a
<filename>wic</filename>-specific option that <filename>wic</filename>-specific option that
names the source of the data that populates names the source of the data that populates
@ -4462,7 +4462,7 @@
"<link linkend='openembedded-kickstart-plugins'>Plugins</link>" "<link linkend='openembedded-kickstart-plugins'>Plugins</link>"
section.</para> section.</para>
<para>If you use <para>If you use
<filename>&dash;&dash;source rootfs</filename>, <filename>--source rootfs</filename>,
<filename>wic</filename> creates a partition as <filename>wic</filename> creates a partition as
large as needed and to fill it with the contents of large as needed and to fill it with the contents of
the root filesystem pointed to by the the root filesystem pointed to by the
@ -4472,14 +4472,14 @@
option. option.
The filesystem type used to create the The filesystem type used to create the
partition is driven by the value of the partition is driven by the value of the
<filename>&dash;&dash;fstype</filename> option <filename>--fstype</filename> option
specified for the partition. specified for the partition.
See the entry on See the entry on
<filename>&dash;&dash;fstype</filename> that <filename>--fstype</filename> that
follows for more information. follows for more information.
</para> </para>
<para>If you use <para>If you use
<filename>&dash;&dash;source <replaceable>plugin-name</replaceable></filename>, <filename>--source <replaceable>plugin-name</replaceable></filename>,
<filename>wic</filename> creates a partition as <filename>wic</filename> creates a partition as
large as needed and fills it with the contents of large as needed and fills it with the contents of
the partition that is generated by the the partition that is generated by the
@ -4492,10 +4492,10 @@
filesystem type end up being are dependent filesystem type end up being are dependent
on the given plugin implementation. on the given plugin implementation.
</para></listitem> </para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;ondisk</filename> or <filename>&dash;&dash;ondrive</filename>:</emphasis> <listitem><para><emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis>
Forces the partition to be created on a particular Forces the partition to be created on a particular
disk.</para></listitem> disk.</para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;fstype</filename>:</emphasis> <listitem><para><emphasis><filename>--fstype</filename>:</emphasis>
Sets the file system type for the partition. Sets the file system type for the partition.
Valid values are: Valid values are:
<itemizedlist> <itemizedlist>
@ -4512,7 +4512,7 @@
<listitem><para><filename>swap</filename> <listitem><para><filename>swap</filename>
</para></listitem> </para></listitem>
</itemizedlist></para></listitem> </itemizedlist></para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;fsoptions</filename>:</emphasis> <listitem><para><emphasis><filename>--fsoptions</filename>:</emphasis>
Specifies a free-form string of options to be Specifies a free-form string of options to be
used when mounting the filesystem. used when mounting the filesystem.
This string will be copied into the This string will be copied into the
@ -4522,15 +4522,15 @@
If not specified, the default string If not specified, the default string
is "defaults". is "defaults".
</para></listitem> </para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;label label</filename>:</emphasis> <listitem><para><emphasis><filename>--label label</filename>:</emphasis>
Specifies the label to give to the filesystem to Specifies the label to give to the filesystem to
be made on the partition. be made on the partition.
If the given label is already in use by another If the given label is already in use by another
filesystem, a new label is created for the filesystem, a new label is created for the
partition.</para></listitem> partition.</para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;active</filename>:</emphasis> <listitem><para><emphasis><filename>--active</filename>:</emphasis>
Marks the partition as active.</para></listitem> Marks the partition as active.</para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;align (in KBytes)</filename>:</emphasis> <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis>
This option is a <filename>wic</filename>-specific This option is a <filename>wic</filename>-specific
option that says to start a partition on an option that says to start a partition on an
x KBytes boundary.</para></listitem> x KBytes boundary.</para></listitem>
@ -4547,17 +4547,17 @@
<note> <note>
Bootloader functionality and boot partitions are Bootloader functionality and boot partitions are
implemented by the various implemented by the various
<filename>&dash;&dash;source</filename> <filename>--source</filename>
plugins that implement bootloader functionality. plugins that implement bootloader functionality.
The bootloader command essentially provides a means of The bootloader command essentially provides a means of
modifying bootloader configuration. modifying bootloader configuration.
</note> </note>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis><filename>&dash;&dash;timeout</filename>:</emphasis> <listitem><para><emphasis><filename>--timeout</filename>:</emphasis>
Specifies the number of seconds before the Specifies the number of seconds before the
bootloader times out and boots the default option. bootloader times out and boots the default option.
</para></listitem> </para></listitem>
<listitem><para><emphasis><filename>&dash;&dash;append</filename>:</emphasis> <listitem><para><emphasis><filename>--append</filename>:</emphasis>
Specifies kernel parameters. Specifies kernel parameters.
These parameters will be added to the syslinux These parameters will be added to the syslinux
<filename>APPEND</filename> or <filename>APPEND</filename> or
@ -6484,7 +6484,7 @@
For this scenario, you need to start the PR Service using For this scenario, you need to start the PR Service using
the <filename>bitbake-prserv</filename> command: the <filename>bitbake-prserv</filename> command:
<literallayout class='monospaced'> <literallayout class='monospaced'>
bitbake-prserv &dash;&dash;host <replaceable>ip</replaceable> &dash;&dash;port <replaceable>port</replaceable> &dash;&dash;start bitbake-prserv --host <replaceable>ip</replaceable> --port <replaceable>port</replaceable> --start
</literallayout> </literallayout>
In addition to hand-starting the service, you need to In addition to hand-starting the service, you need to
update the <filename>local.conf</filename> file of each update the <filename>local.conf</filename> file of each
@ -7136,9 +7136,9 @@
Given this example, issue the following commands on the Given this example, issue the following commands on the
target: target:
<literallayout class='monospaced'> <literallayout class='monospaced'>
# smart channel &dash;&dash;add all type=rpm-md baseurl=http://server.name/rpm/all # smart channel --add all type=rpm-md baseurl=http://server.name/rpm/all
# smart channel &dash;&dash;add i585 type=rpm-md baseurl=http://server.name/rpm/i586 # smart channel --add i585 type=rpm-md baseurl=http://server.name/rpm/i586
# smart channel &dash;&dash;add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86 # smart channel --add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
</literallayout> </literallayout>
Also from the target machine, fetch the repository Also from the target machine, fetch the repository
information using this command: information using this command:
@ -8588,13 +8588,13 @@
Consequently, running the tests on other machine Consequently, running the tests on other machine
means that you have to move the contents and call means that you have to move the contents and call
<filename>runexported.py</filename> with <filename>runexported.py</filename> with
"&dash;&dash;deploy-dir <replaceable>path</replaceable>" as "--deploy-dir <replaceable>path</replaceable>" as
follows: follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
./runexported.py &dash;&dash;deploy-dir /new/path/on/this/machine testdata.json ./runexported.py --deploy-dir /new/path/on/this/machine testdata.json
</literallayout> </literallayout>
<filename>runexported.py</filename> accepts other arguments <filename>runexported.py</filename> accepts other arguments
as well as described using <filename>&dash;&dash;help</filename>. as well as described using <filename>--help</filename>.
</para> </para>
</section> </section>
@ -9054,7 +9054,7 @@
| DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common'] | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common']
| DEBUG: Executing shell function do_compile | DEBUG: Executing shell function do_compile
| NOTE: make -j 16 | NOTE: make -j 16
| make &dash;&dash;no-print-directory all-am | make --no-print-directory all-am
| /bin/mkdir -p include/near | /bin/mkdir -p include/near
| /bin/mkdir -p include/near | /bin/mkdir -p include/near
| /bin/mkdir -p include/near | /bin/mkdir -p include/near
@ -9095,7 +9095,7 @@
| ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/
0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h
| ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h
| i586-poky-linux-gcc -m32 -march=i586 &dash;&dash;sysroot=/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/ | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/
build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/
yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0
-I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ -I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/
@ -9170,7 +9170,7 @@
Here is some abbreviated, sample output with the Here is some abbreviated, sample output with the
missing dependency clearly visible at the end: missing dependency clearly visible at the end:
<literallayout class='monospaced'> <literallayout class='monospaced'>
i586-poky-linux-gcc -m32 -march=i586 &dash;&dash;sysroot=/home/scott-lenovo/...... i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/......
. .
. .
. .
@ -9565,14 +9565,14 @@
<para> <para>
<literallayout class='monospaced'> <literallayout class='monospaced'>
# opcontrol &dash;&dash;reset # opcontrol --reset
# opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5 # opcontrol --start --separate=lib --no-vmlinux -c 5
. .
. .
[do whatever is being profiled] [do whatever is being profiled]
. .
. .
# opcontrol &dash;&dash;stop # opcontrol --stop
$ opreport -cl $ opreport -cl
</literallayout> </literallayout>
</para> </para>
@ -9585,7 +9585,7 @@
five levels deep. five levels deep.
<note> <note>
To profile the kernel, you would specify the To profile the kernel, you would specify the
<filename>&dash;&dash;vmlinux=/path/to/vmlinux</filename> option. <filename>--vmlinux=/path/to/vmlinux</filename> option.
The <filename>vmlinux</filename> file is usually in the source directory in the The <filename>vmlinux</filename> file is usually in the source directory in the
<filename>/boot/</filename> directory and must match the running kernel. <filename>/boot/</filename> directory and must match the running kernel.
</note> </note>
@ -9648,7 +9648,7 @@
With this connection, you just need to run "oprofile-server" on the device. With this connection, you just need to run "oprofile-server" on the device.
By default, OProfile listens on port 4224. By default, OProfile listens on port 4224.
<note> <note>
You can change the port using the <filename>&dash;&dash;port</filename> command-line You can change the port using the <filename>--port</filename> command-line
option. option.
</note> </note>
</para> </para>
@ -9738,14 +9738,14 @@
If network access to the target is unavailable, you can generate If network access to the target is unavailable, you can generate
an archive for processing in <filename>oprofile-viewer</filename> as follows: an archive for processing in <filename>oprofile-viewer</filename> as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
# opcontrol &dash;&dash;reset # opcontrol --reset
# opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5 # opcontrol --start --separate=lib --no-vmlinux -c 5
. .
. .
[do whatever is being profiled] [do whatever is being profiled]
. .
. .
# opcontrol &dash;&dash;stop # opcontrol --stop
# oparchive -o my_archive # oparchive -o my_archive
</literallayout> </literallayout>
</para> </para>

50
documentation/dev-manual/dev-manual-model.xml
View File

@ -1260,7 +1260,7 @@
<filename>aclocal</filename>, <filename>aclocal</filename>,
<filename>autoconf</filename>, <filename>autoconf</filename>,
<filename>autoheader</filename>, <filename>autoheader</filename>,
<filename>automake &dash;&dash;a</filename>, and <filename>automake --a</filename>, and
<filename>./configure</filename>. <filename>./configure</filename>.
Click on the "Console" tab beneath your source code to Click on the "Console" tab beneath your source code to
see the results of reconfiguring your project. see the results of reconfiguring your project.
@ -1978,11 +1978,11 @@
<para> <para>
The easiest way to get help with the The easiest way to get help with the
<filename>devtool</filename> command is using the <filename>devtool</filename> command is using the
<filename>&dash;&dash;help</filename> option: <filename>--help</filename> option:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool &dash;&dash;help $ devtool --help
usage: devtool [-h] [&dash;&dash;basepath BASEPATH] [-d] [-q] usage: devtool [-h] [--basepath BASEPATH] [-d] [-q]
[&dash;&dash;color {auto,always,never}] [--color {auto,always,never}]
{create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset} {create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset}
... ...
@ -2002,32 +2002,32 @@
reset Remove a recipe from your workspace reset Remove a recipe from your workspace
optional arguments: optional arguments:
-h, &dash;&dash;help show this help message and exit -h, --help show this help message and exit
&dash;&dash;basepath BASEPATH Base directory of SDK / build directory --basepath BASEPATH Base directory of SDK / build directory
-d, &dash;&dash;debug Enable debug output -d, --debug Enable debug output
-q, &dash;&dash;quiet Print only errors -q, --quiet Print only errors
&dash;&dash;color {auto,always,never} --color {auto,always,never}
Colorize output Colorize output
Use devtool &lt;command&gt; &dash;&dash;help to get help on a specific command Use devtool &lt;command&gt; --help to get help on a specific command
</literallayout> </literallayout>
</para> </para>
<para> <para>
As directed in the general help output, you can get more As directed in the general help output, you can get more
syntax on a specific command by providing the command syntax on a specific command by providing the command
name and using <filename>&dash;&dash;help</filename>: name and using <filename>--help</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool add &dash;&dash;help $ devtool add --help
usage: devtool add [-h] [&dash;&dash;version VERSION] recipename srctree usage: devtool add [-h] [--version VERSION] recipename srctree
positional arguments: positional arguments:
recipename Name for new recipe to add recipename Name for new recipe to add
srctree Path to external source tree srctree Path to external source tree
optional arguments: optional arguments:
-h, &dash;&dash;help show this help message and exit -h, --help show this help message and exit
&dash;&dash;version VERSION, -V VERSION --version VERSION, -V VERSION
</literallayout> </literallayout>
</para> </para>
</section> </section>
@ -2054,7 +2054,7 @@
</literallayout> </literallayout>
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool add &dash;&dash;help</filename> command. <filename>devtool add --help</filename> command.
</note> </note>
</para> </para>
@ -2112,7 +2112,7 @@
</literallayout> </literallayout>
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool create-workspace &dash;&dash;help</filename> command. <filename>devtool create-workspace --help</filename> command.
</note> </note>
</para> </para>
@ -2162,7 +2162,7 @@
</literallayout> </literallayout>
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool modify &dash;&dash;help</filename> command. <filename>devtool modify --help</filename> command.
</note> </note>
</para> </para>
</section> </section>
@ -2182,7 +2182,7 @@
layer before running the <filename>reset</filename> command. layer before running the <filename>reset</filename> command.
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool reset &dash;&dash;help</filename> command. <filename>devtool reset --help</filename> command.
</note> </note>
</para> </para>
</section> </section>
@ -2208,7 +2208,7 @@
</literallayout> </literallayout>
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool update-recipe &dash;&dash;help</filename> command. <filename>devtool update-recipe --help</filename> command.
</note> </note>
</para> </para>
</section> </section>
@ -2225,7 +2225,7 @@
</literallayout> </literallayout>
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool update-recipe &dash;&dash;help</filename> command. <filename>devtool update-recipe --help</filename> command.
</note> </note>
Building your software using <filename>build</filename> is Building your software using <filename>build</filename> is
identical to using BitBake to build the software. identical to using BitBake to build the software.
@ -2246,7 +2246,7 @@
<filename>user@hostname[:destdir]</filename>. <filename>user@hostname[:destdir]</filename>.
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool deploy-target &dash;&dash;help</filename> command. <filename>devtool deploy-target --help</filename> command.
</note> </note>
</para> </para>
</section> </section>
@ -2269,7 +2269,7 @@
<filename>user@hostname</filename>. <filename>user@hostname</filename>.
<note> <note>
For complete syntax, use the For complete syntax, use the
<filename>devtool undeploy-target &dash;&dash;help</filename> command. <filename>devtool undeploy-target --help</filename> command.
</note> </note>
</para> </para>
</section> </section>
@ -2330,7 +2330,7 @@
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ bitbake -c compile -f <replaceable>package</replaceable> $ bitbake -c compile -f <replaceable>package</replaceable>
</literallayout> </literallayout>
The <filename>-f</filename> or <filename>&dash;&dash;force</filename> The <filename>-f</filename> or <filename>--force</filename>
option forces the specified task to execute. option forces the specified task to execute.
If you find problems with your code, you can just keep editing and If you find problems with your code, you can just keep editing and
re-testing iteratively until things work as expected. re-testing iteratively until things work as expected.

6
documentation/ref-manual/migration.xml
View File

@ -1014,7 +1014,7 @@
The <filename>buildhistory-diff</filename> and The <filename>buildhistory-diff</filename> and
<filename>buildhistory-collect-srcrevs</filename> <filename>buildhistory-collect-srcrevs</filename>
utilities have improved command-line handling. utilities have improved command-line handling.
Use the <filename>&dash;&dash;help</filename> option for Use the <filename>--help</filename> option for
each utility for more information on the new syntax. each utility for more information on the new syntax.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
@ -1730,7 +1730,7 @@
The minimum The minimum
<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required
on the build host is now 1.7.8 because the on the build host is now 1.7.8 because the
<filename>&dash;&dash;list</filename> option is now required by <filename>--list</filename> option is now required by
BitBake's Git fetcher. BitBake's Git fetcher.
As always, if your host distribution does not provide a version of As always, if your host distribution does not provide a version of
Git that meets this requirement, you can use the Git that meets this requirement, you can use the
@ -1770,7 +1770,7 @@
class instead of the <filename>autotools</filename> class. class instead of the <filename>autotools</filename> class.
</para></listitem> </para></listitem>
<listitem><para><emphasis> <listitem><para><emphasis>
The <filename>&dash;&dash;foreign</filename> option is The <filename>--foreign</filename> option is
no longer passed to <filename>automake</filename> when no longer passed to <filename>automake</filename> when
running <filename>autoconf</filename>:</emphasis> running <filename>autoconf</filename>:</emphasis>
This option tells <filename>automake</filename> that a This option tells <filename>automake</filename> that a

2
documentation/ref-manual/ref-qa-checks.xml
View File

@ -894,7 +894,7 @@ can be found then it should be implemented. I can't find one at the moment.
and there is another option that should be used instead. and there is another option that should be used instead.
If you are unsure, consult the upstream build If you are unsure, consult the upstream build
documentation, the documentation, the
<filename>./configure &dash;&dash;help</filename> output, <filename>./configure --help</filename> output,
and the upstream change log or release notes. and the upstream change log or release notes.
Once you have worked out what the appropriate Once you have worked out what the appropriate
change is, you can update change is, you can update