summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-03-04 08:55:54 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-03-06 10:44:43 +0000
commitc504276d260571da38a20ff9c58ffc2e0c760fbb (patch)
tree8fa504b6600d231adaa3ab10610cb164a588c303 /documentation
parenta889cc011c65e29b2ed51db23c12d70bc81f01e8 (diff)
downloadpoky-c504276d260571da38a20ff9c58ffc2e0c760fbb.tar.gz
dev-manual, ref-manual: Replaced &dash;&dash; with "--"
Fixes [YOCTO #7386] Apparently, copying HTML displayed commands that have a double dash created through "&dash;&dash;" in the docbook source causes some issues in the shell. I have scrubbed the manual set to replace any "&dash;&dash;" 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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml126
-rw-r--r--documentation/dev-manual/dev-manual-model.xml50
-rw-r--r--documentation/ref-manual/migration.xml6
-rw-r--r--documentation/ref-manual/ref-qa-checks.xml2
4 files changed, 92 insertions, 92 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ce5cbf2528..9030b96264 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -741,13 +741,13 @@
741 ... 741 ...
742 DESCRIPTION = "A useful utility" 742 DESCRIPTION = "A useful utility"
743 ... 743 ...
744 EXTRA_OECONF = "&dash;&dash;enable-something" 744 EXTRA_OECONF = "--enable-something"
745 ... 745 ...
746 746
747 #### bbappended from meta-anotherlayer #### 747 #### bbappended from meta-anotherlayer ####
748 748
749 DESCRIPTION = "Customized utility" 749 DESCRIPTION = "Customized utility"
750 EXTRA_OECONF += "&dash;&dash;enable-somethingelse" 750 EXTRA_OECONF += "--enable-somethingelse"
751 </literallayout> 751 </literallayout>
752 Ideally, you would tidy up these utilities as 752 Ideally, you would tidy up these utilities as
753 follows: 753 follows:
@@ -755,7 +755,7 @@
755 ... 755 ...
756 DESCRIPTION = "Customized utility" 756 DESCRIPTION = "Customized utility"
757 ... 757 ...
758 EXTRA_OECONF = "&dash;&dash;enable-something &dash;&dash;enable-somethingelse" 758 EXTRA_OECONF = "--enable-something --enable-somethingelse"
759 ... 759 ...
760 </literallayout></para></listitem> 760 </literallayout></para></listitem>
761 </itemizedlist></para></listitem> 761 </itemizedlist></para></listitem>
@@ -2275,7 +2275,7 @@
2275 configure script with the appropriate options.</para> 2275 configure script with the appropriate options.</para>
2276 <para>For the case involving a custom configure 2276 <para>For the case involving a custom configure
2277 script, you would run 2277 script, you would run
2278 <filename>./configure &dash;&dash;help</filename> and look for 2278 <filename>./configure --help</filename> and look for
2279 the options you need to set.</para></listitem> 2279 the options you need to set.</para></listitem>
2280 </itemizedlist> 2280 </itemizedlist>
2281 </para> 2281 </para>
@@ -2298,7 +2298,7 @@
2298 configure script as needed. 2298 configure script as needed.
2299 For reference information on configure options specific to the 2299 For reference information on configure options specific to the
2300 software you are building, you can consult the output of the 2300 software you are building, you can consult the output of the
2301 <filename>./configure &dash;&dash;help</filename> command within 2301 <filename>./configure --help</filename> command within
2302 <filename>${S}</filename> or consult the software's upstream 2302 <filename>${S}</filename> or consult the software's upstream
2303 documentation. 2303 documentation.
2304 </para> 2304 </para>
@@ -3780,7 +3780,7 @@
3780 or by entering the command with a help argument as follows: 3780 or by entering the command with a help argument as follows:
3781 <literallayout class='monospaced'> 3781 <literallayout class='monospaced'>
3782 $ wic -h 3782 $ wic -h
3783 $ wic &dash;&dash;help 3783 $ wic --help
3784 </literallayout> 3784 </literallayout>
3785 </para> 3785 </para>
3786 3786
@@ -3796,7 +3796,7 @@
3796 <para> 3796 <para>
3797 You can also get detailed help on a number of topics 3797 You can also get detailed help on a number of topics
3798 from the help system. 3798 from the help system.
3799 The output of <filename>wic &dash;&dash;help</filename> 3799 The output of <filename>wic --help</filename>
3800 displays a list of available help 3800 displays a list of available help
3801 topics under a "Help topics" heading. 3801 topics under a "Help topics" heading.
3802 You can have the help system display the help text for 3802 You can have the help system display the help text for
@@ -3866,38 +3866,38 @@
3866 your own custom file or use a file from a set of 3866 your own custom file or use a file from a set of
3867 existing files as described by further options. 3867 existing files as described by further options.
3868 3868
3869 -o <replaceable>OUTDIR</replaceable>, &dash;&dash;outdir=<replaceable>OUTDIR</replaceable> 3869 -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable>
3870 The name of a directory in which to create image. 3870 The name of a directory in which to create image.
3871 3871
3872 -i <replaceable>PROPERTIES_FILE</replaceable>, &dash;&dash;infile=<replaceable>PROPERTIES_FILE</replaceable> 3872 -i <replaceable>PROPERTIES_FILE</replaceable>, --infile=<replaceable>PROPERTIES_FILE</replaceable>
3873 The name of a file containing the values for image 3873 The name of a file containing the values for image
3874 properties as a JSON file. 3874 properties as a JSON file.
3875 3875
3876 -e <replaceable>IMAGE_NAME</replaceable>, &dash;&dash;image-name=<replaceable>IMAGE_NAME</replaceable> 3876 -e <replaceable>IMAGE_NAME</replaceable>, --image-name=<replaceable>IMAGE_NAME</replaceable>
3877 The name of the image from which to use the artifacts 3877 The name of the image from which to use the artifacts
3878 (e.g. <filename>core-image-sato</filename>). 3878 (e.g. <filename>core-image-sato</filename>).
3879 3879
3880 -r <replaceable>ROOTFS_DIR</replaceable>, &dash;&dash;rootfs-dir=<replaceable>ROOTFS_DIR</replaceable> 3880 -r <replaceable>ROOTFS_DIR</replaceable>, --rootfs-dir=<replaceable>ROOTFS_DIR</replaceable>
3881 The path to the <filename>/rootfs</filename> directory to use as the 3881 The path to the <filename>/rootfs</filename> directory to use as the
3882 <filename>.wks</filename> rootfs source. 3882 <filename>.wks</filename> rootfs source.
3883 3883
3884 -b <replaceable>BOOTIMG_DIR</replaceable>, &dash;&dash;bootimg-dir=<replaceable>BOOTIMG_DIR</replaceable> 3884 -b <replaceable>BOOTIMG_DIR</replaceable>, --bootimg-dir=<replaceable>BOOTIMG_DIR</replaceable>
3885 The path to the directory containing the boot artifacts 3885 The path to the directory containing the boot artifacts
3886 (e.g. <filename>/EFI</filename> or <filename>/syslinux</filename>) to use as the <filename>.wks</filename> bootimg 3886 (e.g. <filename>/EFI</filename> or <filename>/syslinux</filename>) to use as the <filename>.wks</filename> bootimg
3887 source. 3887 source.
3888 3888
3889 -k <replaceable>KERNEL_DIR</replaceable>, &dash;&dash;kernel-dir=<replaceable>KERNEL_DIR</replaceable> 3889 -k <replaceable>KERNEL_DIR</replaceable>, --kernel-dir=<replaceable>KERNEL_DIR</replaceable>
3890 The path to the directory containing the kernel to use 3890 The path to the directory containing the kernel to use
3891 in the <filename>.wks</filename> boot image. 3891 in the <filename>.wks</filename> boot image.
3892 3892
3893 -n <replaceable>NATIVE_SYSROOT</replaceable>, &dash;&dash;native-sysroot=<replaceable>NATIVE_SYSROOT</replaceable> 3893 -n <replaceable>NATIVE_SYSROOT</replaceable>, --native-sysroot=<replaceable>NATIVE_SYSROOT</replaceable>
3894 The path to the native sysroot containing the tools to use 3894 The path to the native sysroot containing the tools to use
3895 to build the image. 3895 to build the image.
3896 3896
3897 -s, &dash;&dash;skip-build-check 3897 -s, --skip-build-check
3898 Skips the build check. 3898 Skips the build check.
3899 3899
3900 -D, &dash;&dash;debug 3900 -D, --debug
3901 Output debug information. 3901 Output debug information.
3902 </literallayout> 3902 </literallayout>
3903 <note> 3903 <note>
@@ -4107,13 +4107,13 @@
4107 </literallayout> 4107 </literallayout>
4108 Next, the example modifies the 4108 Next, the example modifies the
4109 <filename>directdisksdb.wks</filename> file and changes all 4109 <filename>directdisksdb.wks</filename> file and changes all
4110 instances of "<filename>&dash;&dash;ondisk sda</filename>" 4110 instances of "<filename>--ondisk sda</filename>"
4111 to "<filename>&dash;&dash;ondisk sdb</filename>". 4111 to "<filename>--ondisk sdb</filename>".
4112 The example changes the following two lines and leaves the 4112 The example changes the following two lines and leaves the
4113 remaining lines untouched: 4113 remaining lines untouched:
4114 <literallayout class='monospaced'> 4114 <literallayout class='monospaced'>
4115 part /boot &dash;&dash;source bootimg-pcbios &dash;&dash;ondisk sdb &dash;&dash;label boot &dash;&dash;active &dash;&dash;align 1024 4115 part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024
4116 part / &dash;&dash;source rootfs &dash;&dash;ondisk sdb &dash;&dash;fstype=ext3 &dash;&dash;label platform &dash;&dash;align 1024 4116 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
4117 </literallayout> 4117 </literallayout>
4118 Once the lines are changed, the example generates the 4118 Once the lines are changed, the example generates the
4119 <filename>directdisksdb</filename> image. 4119 <filename>directdisksdb</filename> image.
@@ -4200,11 +4200,11 @@
4200 somewhere other than the default 4200 somewhere other than the default
4201 <filename>/var/tmp/wic</filename> directory: 4201 <filename>/var/tmp/wic</filename> directory:
4202 <literallayout class='monospaced'> 4202 <literallayout class='monospaced'>
4203 $ wic create ~/test.wks -o /home/trz/testwic &dash;&dash;rootfs-dir \ 4203 $ wic create ~/test.wks -o /home/trz/testwic --rootfs-dir \
4204 /home/trz/yocto/yocto-image/build/tmp/work/crownbay_noemgd-poky-linux/core-image-minimal/1.0-r0/rootfs \ 4204 /home/trz/yocto/yocto-image/build/tmp/work/crownbay_noemgd-poky-linux/core-image-minimal/1.0-r0/rootfs \
4205 &dash;&dash;bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \ 4205 --bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \
4206 &dash;&dash;kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \ 4206 --kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \
4207 &dash;&dash;native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux 4207 --native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux
4208 4208
4209 Creating image(s)... 4209 Creating image(s)...
4210 4210
@@ -4247,7 +4247,7 @@
4247 partitions. 4247 partitions.
4248 The plugins provide a mechanism for mapping values 4248 The plugins provide a mechanism for mapping values
4249 specified in <filename>.wks</filename> files using the 4249 specified in <filename>.wks</filename> files using the
4250 <filename>&dash;&dash;source</filename> keyword to a 4250 <filename>--source</filename> keyword to a
4251 particular plugin implementation that populates a 4251 particular plugin implementation that populates a
4252 corresponding partition. 4252 corresponding partition.
4253 </para> 4253 </para>
@@ -4276,11 +4276,11 @@
4276 When the <filename>wic</filename> implementation needs 4276 When the <filename>wic</filename> implementation needs
4277 to invoke a partition-specific implementation, it looks 4277 to invoke a partition-specific implementation, it looks
4278 for the plugin that has the same name as the 4278 for the plugin that has the same name as the
4279 <filename>&dash;&dash;source</filename> parameter given to 4279 <filename>--source</filename> parameter given to
4280 that partition. 4280 that partition.
4281 For example, if the partition is set up as follows: 4281 For example, if the partition is set up as follows:
4282 <literallayout class='monospaced'> 4282 <literallayout class='monospaced'>
4283 part /boot &dash;&dash;source bootimg-pcbios ... 4283 part /boot --source bootimg-pcbios ...
4284 </literallayout> 4284 </literallayout>
4285 The methods defined as class members of the plugin 4285 The methods defined as class members of the plugin
4286 having the matching <filename>bootimg-pcbios.name</filename> 4286 having the matching <filename>bootimg-pcbios.name</filename>
@@ -4290,7 +4290,7 @@
4290 <para> 4290 <para>
4291 To be more concrete, here is the plugin definition that 4291 To be more concrete, here is the plugin definition that
4292 matches a 4292 matches a
4293 <filename>&dash;&dash;source bootimg-pcbios</filename> usage, 4293 <filename>--source bootimg-pcbios</filename> usage,
4294 along with an example 4294 along with an example
4295 method called by the <filename>wic</filename> implementation 4295 method called by the <filename>wic</filename> implementation
4296 when it needs to invoke an implementation-specific 4296 when it needs to invoke an implementation-specific
@@ -4312,7 +4312,7 @@
4312 The <filename>SourcePlugin</filename> class defines the 4312 The <filename>SourcePlugin</filename> class defines the
4313 following methods, which is the current set of methods 4313 following methods, which is the current set of methods
4314 that can be implemented or overridden by 4314 that can be implemented or overridden by
4315 <filename>&dash;&dash;source</filename> plugins. 4315 <filename>--source</filename> plugins.
4316 Any methods not implemented by a 4316 Any methods not implemented by a
4317 <filename>SourcePlugin</filename> subclass inherit the 4317 <filename>SourcePlugin</filename> subclass inherit the
4318 implementations present in the 4318 implementations present in the
@@ -4444,13 +4444,13 @@
4444 <para> 4444 <para>
4445 Following are the supported options: 4445 Following are the supported options:
4446 <itemizedlist> 4446 <itemizedlist>
4447 <listitem><para><emphasis><filename>&dash;&dash;size</filename>:</emphasis> 4447 <listitem><para><emphasis><filename>--size</filename>:</emphasis>
4448 The minimum partition size in MBytes. 4448 The minimum partition size in MBytes.
4449 Specify an integer value such as 500. 4449 Specify an integer value such as 500.
4450 Do not append the number with "MB". 4450 Do not append the number with "MB".
4451 You do not need this option if you use 4451 You do not need this option if you use
4452 <filename>&dash;&dash;source</filename>.</para></listitem> 4452 <filename>--source</filename>.</para></listitem>
4453 <listitem><para><emphasis><filename>&dash;&dash;source</filename>:</emphasis> 4453 <listitem><para><emphasis><filename>--source</filename>:</emphasis>
4454 This option is a 4454 This option is a
4455 <filename>wic</filename>-specific option that 4455 <filename>wic</filename>-specific option that
4456 names the source of the data that populates 4456 names the source of the data that populates
@@ -4462,7 +4462,7 @@
4462 "<link linkend='openembedded-kickstart-plugins'>Plugins</link>" 4462 "<link linkend='openembedded-kickstart-plugins'>Plugins</link>"
4463 section.</para> 4463 section.</para>
4464 <para>If you use 4464 <para>If you use
4465 <filename>&dash;&dash;source rootfs</filename>, 4465 <filename>--source rootfs</filename>,
4466 <filename>wic</filename> creates a partition as 4466 <filename>wic</filename> creates a partition as
4467 large as needed and to fill it with the contents of 4467 large as needed and to fill it with the contents of
4468 the root filesystem pointed to by the 4468 the root filesystem pointed to by the
@@ -4472,14 +4472,14 @@
4472 option. 4472 option.
4473 The filesystem type used to create the 4473 The filesystem type used to create the
4474 partition is driven by the value of the 4474 partition is driven by the value of the
4475 <filename>&dash;&dash;fstype</filename> option 4475 <filename>--fstype</filename> option
4476 specified for the partition. 4476 specified for the partition.
4477 See the entry on 4477 See the entry on
4478 <filename>&dash;&dash;fstype</filename> that 4478 <filename>--fstype</filename> that
4479 follows for more information. 4479 follows for more information.
4480 </para> 4480 </para>
4481 <para>If you use 4481 <para>If you use
4482 <filename>&dash;&dash;source <replaceable>plugin-name</replaceable></filename>, 4482 <filename>--source <replaceable>plugin-name</replaceable></filename>,
4483 <filename>wic</filename> creates a partition as 4483 <filename>wic</filename> creates a partition as
4484 large as needed and fills it with the contents of 4484 large as needed and fills it with the contents of
4485 the partition that is generated by the 4485 the partition that is generated by the
@@ -4492,10 +4492,10 @@
4492 filesystem type end up being are dependent 4492 filesystem type end up being are dependent
4493 on the given plugin implementation. 4493 on the given plugin implementation.
4494 </para></listitem> 4494 </para></listitem>
4495 <listitem><para><emphasis><filename>&dash;&dash;ondisk</filename> or <filename>&dash;&dash;ondrive</filename>:</emphasis> 4495 <listitem><para><emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis>
4496 Forces the partition to be created on a particular 4496 Forces the partition to be created on a particular
4497 disk.</para></listitem> 4497 disk.</para></listitem>
4498 <listitem><para><emphasis><filename>&dash;&dash;fstype</filename>:</emphasis> 4498 <listitem><para><emphasis><filename>--fstype</filename>:</emphasis>
4499 Sets the file system type for the partition. 4499 Sets the file system type for the partition.
4500 Valid values are: 4500 Valid values are:
4501 <itemizedlist> 4501 <itemizedlist>
@@ -4512,7 +4512,7 @@
4512 <listitem><para><filename>swap</filename> 4512 <listitem><para><filename>swap</filename>
4513 </para></listitem> 4513 </para></listitem>
4514 </itemizedlist></para></listitem> 4514 </itemizedlist></para></listitem>
4515 <listitem><para><emphasis><filename>&dash;&dash;fsoptions</filename>:</emphasis> 4515 <listitem><para><emphasis><filename>--fsoptions</filename>:</emphasis>
4516 Specifies a free-form string of options to be 4516 Specifies a free-form string of options to be
4517 used when mounting the filesystem. 4517 used when mounting the filesystem.
4518 This string will be copied into the 4518 This string will be copied into the
@@ -4522,15 +4522,15 @@
4522 If not specified, the default string 4522 If not specified, the default string
4523 is "defaults". 4523 is "defaults".
4524 </para></listitem> 4524 </para></listitem>
4525 <listitem><para><emphasis><filename>&dash;&dash;label label</filename>:</emphasis> 4525 <listitem><para><emphasis><filename>--label label</filename>:</emphasis>
4526 Specifies the label to give to the filesystem to 4526 Specifies the label to give to the filesystem to
4527 be made on the partition. 4527 be made on the partition.
4528 If the given label is already in use by another 4528 If the given label is already in use by another
4529 filesystem, a new label is created for the 4529 filesystem, a new label is created for the
4530 partition.</para></listitem> 4530 partition.</para></listitem>
4531 <listitem><para><emphasis><filename>&dash;&dash;active</filename>:</emphasis> 4531 <listitem><para><emphasis><filename>--active</filename>:</emphasis>
4532 Marks the partition as active.</para></listitem> 4532 Marks the partition as active.</para></listitem>
4533 <listitem><para><emphasis><filename>&dash;&dash;align (in KBytes)</filename>:</emphasis> 4533 <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis>
4534 This option is a <filename>wic</filename>-specific 4534 This option is a <filename>wic</filename>-specific
4535 option that says to start a partition on an 4535 option that says to start a partition on an
4536 x KBytes boundary.</para></listitem> 4536 x KBytes boundary.</para></listitem>
@@ -4547,17 +4547,17 @@
4547 <note> 4547 <note>
4548 Bootloader functionality and boot partitions are 4548 Bootloader functionality and boot partitions are
4549 implemented by the various 4549 implemented by the various
4550 <filename>&dash;&dash;source</filename> 4550 <filename>--source</filename>
4551 plugins that implement bootloader functionality. 4551 plugins that implement bootloader functionality.
4552 The bootloader command essentially provides a means of 4552 The bootloader command essentially provides a means of
4553 modifying bootloader configuration. 4553 modifying bootloader configuration.
4554 </note> 4554 </note>
4555 <itemizedlist> 4555 <itemizedlist>
4556 <listitem><para><emphasis><filename>&dash;&dash;timeout</filename>:</emphasis> 4556 <listitem><para><emphasis><filename>--timeout</filename>:</emphasis>
4557 Specifies the number of seconds before the 4557 Specifies the number of seconds before the
4558 bootloader times out and boots the default option. 4558 bootloader times out and boots the default option.
4559 </para></listitem> 4559 </para></listitem>
4560 <listitem><para><emphasis><filename>&dash;&dash;append</filename>:</emphasis> 4560 <listitem><para><emphasis><filename>--append</filename>:</emphasis>
4561 Specifies kernel parameters. 4561 Specifies kernel parameters.
4562 These parameters will be added to the syslinux 4562 These parameters will be added to the syslinux
4563 <filename>APPEND</filename> or 4563 <filename>APPEND</filename> or
@@ -6484,7 +6484,7 @@
6484 For this scenario, you need to start the PR Service using 6484 For this scenario, you need to start the PR Service using
6485 the <filename>bitbake-prserv</filename> command: 6485 the <filename>bitbake-prserv</filename> command:
6486 <literallayout class='monospaced'> 6486 <literallayout class='monospaced'>
6487 bitbake-prserv &dash;&dash;host <replaceable>ip</replaceable> &dash;&dash;port <replaceable>port</replaceable> &dash;&dash;start 6487 bitbake-prserv --host <replaceable>ip</replaceable> --port <replaceable>port</replaceable> --start
6488 </literallayout> 6488 </literallayout>
6489 In addition to hand-starting the service, you need to 6489 In addition to hand-starting the service, you need to
6490 update the <filename>local.conf</filename> file of each 6490 update the <filename>local.conf</filename> file of each
@@ -7136,9 +7136,9 @@
7136 Given this example, issue the following commands on the 7136 Given this example, issue the following commands on the
7137 target: 7137 target:
7138 <literallayout class='monospaced'> 7138 <literallayout class='monospaced'>
7139 # smart channel &dash;&dash;add all type=rpm-md baseurl=http://server.name/rpm/all 7139 # smart channel --add all type=rpm-md baseurl=http://server.name/rpm/all
7140 # smart channel &dash;&dash;add i585 type=rpm-md baseurl=http://server.name/rpm/i586 7140 # smart channel --add i585 type=rpm-md baseurl=http://server.name/rpm/i586
7141 # smart channel &dash;&dash;add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86 7141 # smart channel --add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
7142 </literallayout> 7142 </literallayout>
7143 Also from the target machine, fetch the repository 7143 Also from the target machine, fetch the repository
7144 information using this command: 7144 information using this command:
@@ -8588,13 +8588,13 @@
8588 Consequently, running the tests on other machine 8588 Consequently, running the tests on other machine
8589 means that you have to move the contents and call 8589 means that you have to move the contents and call
8590 <filename>runexported.py</filename> with 8590 <filename>runexported.py</filename> with
8591 "&dash;&dash;deploy-dir <replaceable>path</replaceable>" as 8591 "--deploy-dir <replaceable>path</replaceable>" as
8592 follows: 8592 follows:
8593 <literallayout class='monospaced'> 8593 <literallayout class='monospaced'>
8594 ./runexported.py &dash;&dash;deploy-dir /new/path/on/this/machine testdata.json 8594 ./runexported.py --deploy-dir /new/path/on/this/machine testdata.json
8595 </literallayout> 8595 </literallayout>
8596 <filename>runexported.py</filename> accepts other arguments 8596 <filename>runexported.py</filename> accepts other arguments
8597 as well as described using <filename>&dash;&dash;help</filename>. 8597 as well as described using <filename>--help</filename>.
8598 </para> 8598 </para>
8599 </section> 8599 </section>
8600 8600
@@ -9054,7 +9054,7 @@
9054 | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common'] 9054 | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common']
9055 | DEBUG: Executing shell function do_compile 9055 | DEBUG: Executing shell function do_compile
9056 | NOTE: make -j 16 9056 | NOTE: make -j 16
9057 | make &dash;&dash;no-print-directory all-am 9057 | make --no-print-directory all-am
9058 | /bin/mkdir -p include/near 9058 | /bin/mkdir -p include/near
9059 | /bin/mkdir -p include/near 9059 | /bin/mkdir -p include/near
9060 | /bin/mkdir -p include/near 9060 | /bin/mkdir -p include/near
@@ -9095,7 +9095,7 @@
9095 | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/ 9095 | ln -s /home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/work/i586-poky-linux/neard/
9096 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h 9096 0.14-r0/neard-0.14/include/dbus.h include/near/dbus.h
9097 | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h 9097 | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h
9098 | i586-poky-linux-gcc -m32 -march=i586 &dash;&dash;sysroot=/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/ 9098 | i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/
9099 build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/ 9099 build/build/tmp/sysroots/qemux86 -DHAVE_CONFIG_H -I. -I./include -I./src -I./gdbus -I/home/pokybuild/
9100 yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0 9100 yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/include/glib-2.0
9101 -I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/ 9101 -I/home/pokybuild/yocto-autobuilder/yocto-slave/nightly-x86/build/build/tmp/sysroots/qemux86/usr/
@@ -9170,7 +9170,7 @@
9170 Here is some abbreviated, sample output with the 9170 Here is some abbreviated, sample output with the
9171 missing dependency clearly visible at the end: 9171 missing dependency clearly visible at the end:
9172 <literallayout class='monospaced'> 9172 <literallayout class='monospaced'>
9173 i586-poky-linux-gcc -m32 -march=i586 &dash;&dash;sysroot=/home/scott-lenovo/...... 9173 i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/......
9174 . 9174 .
9175 . 9175 .
9176 . 9176 .
@@ -9565,14 +9565,14 @@
9565 9565
9566 <para> 9566 <para>
9567 <literallayout class='monospaced'> 9567 <literallayout class='monospaced'>
9568 # opcontrol &dash;&dash;reset 9568 # opcontrol --reset
9569 # opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5 9569 # opcontrol --start --separate=lib --no-vmlinux -c 5
9570 . 9570 .
9571 . 9571 .
9572 [do whatever is being profiled] 9572 [do whatever is being profiled]
9573 . 9573 .
9574 . 9574 .
9575 # opcontrol &dash;&dash;stop 9575 # opcontrol --stop
9576 $ opreport -cl 9576 $ opreport -cl
9577 </literallayout> 9577 </literallayout>
9578 </para> 9578 </para>
@@ -9585,7 +9585,7 @@
9585 five levels deep. 9585 five levels deep.
9586 <note> 9586 <note>
9587 To profile the kernel, you would specify the 9587 To profile the kernel, you would specify the
9588 <filename>&dash;&dash;vmlinux=/path/to/vmlinux</filename> option. 9588 <filename>--vmlinux=/path/to/vmlinux</filename> option.
9589 The <filename>vmlinux</filename> file is usually in the source directory in the 9589 The <filename>vmlinux</filename> file is usually in the source directory in the
9590 <filename>/boot/</filename> directory and must match the running kernel. 9590 <filename>/boot/</filename> directory and must match the running kernel.
9591 </note> 9591 </note>
@@ -9648,7 +9648,7 @@
9648 With this connection, you just need to run "oprofile-server" on the device. 9648 With this connection, you just need to run "oprofile-server" on the device.
9649 By default, OProfile listens on port 4224. 9649 By default, OProfile listens on port 4224.
9650 <note> 9650 <note>
9651 You can change the port using the <filename>&dash;&dash;port</filename> command-line 9651 You can change the port using the <filename>--port</filename> command-line
9652 option. 9652 option.
9653 </note> 9653 </note>
9654 </para> 9654 </para>
@@ -9738,14 +9738,14 @@
9738 If network access to the target is unavailable, you can generate 9738 If network access to the target is unavailable, you can generate
9739 an archive for processing in <filename>oprofile-viewer</filename> as follows: 9739 an archive for processing in <filename>oprofile-viewer</filename> as follows:
9740 <literallayout class='monospaced'> 9740 <literallayout class='monospaced'>
9741 # opcontrol &dash;&dash;reset 9741 # opcontrol --reset
9742 # opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5 9742 # opcontrol --start --separate=lib --no-vmlinux -c 5
9743 . 9743 .
9744 . 9744 .
9745 [do whatever is being profiled] 9745 [do whatever is being profiled]
9746 . 9746 .
9747 . 9747 .
9748 # opcontrol &dash;&dash;stop 9748 # opcontrol --stop
9749 # oparchive -o my_archive 9749 # oparchive -o my_archive
9750 </literallayout> 9750 </literallayout>
9751 </para> 9751 </para>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index dc4a540046..c8278eb934 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1260,7 +1260,7 @@
1260 <filename>aclocal</filename>, 1260 <filename>aclocal</filename>,
1261 <filename>autoconf</filename>, 1261 <filename>autoconf</filename>,
1262 <filename>autoheader</filename>, 1262 <filename>autoheader</filename>,
1263 <filename>automake &dash;&dash;a</filename>, and 1263 <filename>automake --a</filename>, and
1264 <filename>./configure</filename>. 1264 <filename>./configure</filename>.
1265 Click on the "Console" tab beneath your source code to 1265 Click on the "Console" tab beneath your source code to
1266 see the results of reconfiguring your project. 1266 see the results of reconfiguring your project.
@@ -1978,11 +1978,11 @@
1978 <para> 1978 <para>
1979 The easiest way to get help with the 1979 The easiest way to get help with the
1980 <filename>devtool</filename> command is using the 1980 <filename>devtool</filename> command is using the
1981 <filename>&dash;&dash;help</filename> option: 1981 <filename>--help</filename> option:
1982 <literallayout class='monospaced'> 1982 <literallayout class='monospaced'>
1983 $ devtool &dash;&dash;help 1983 $ devtool --help
1984 usage: devtool [-h] [&dash;&dash;basepath BASEPATH] [-d] [-q] 1984 usage: devtool [-h] [--basepath BASEPATH] [-d] [-q]
1985 [&dash;&dash;color {auto,always,never}] 1985 [--color {auto,always,never}]
1986 {create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset} 1986 {create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset}
1987 ... 1987 ...
1988 1988
@@ -2002,32 +2002,32 @@
2002 reset Remove a recipe from your workspace 2002 reset Remove a recipe from your workspace
2003 2003
2004 optional arguments: 2004 optional arguments:
2005 -h, &dash;&dash;help show this help message and exit 2005 -h, --help show this help message and exit
2006 &dash;&dash;basepath BASEPATH Base directory of SDK / build directory 2006 --basepath BASEPATH Base directory of SDK / build directory
2007 -d, &dash;&dash;debug Enable debug output 2007 -d, --debug Enable debug output
2008 -q, &dash;&dash;quiet Print only errors 2008 -q, --quiet Print only errors
2009 &dash;&dash;color {auto,always,never} 2009 --color {auto,always,never}
2010 Colorize output 2010 Colorize output
2011 2011
2012 Use devtool &lt;command&gt; &dash;&dash;help to get help on a specific command 2012 Use devtool &lt;command&gt; --help to get help on a specific command
2013 </literallayout> 2013 </literallayout>
2014 </para> 2014 </para>
2015 2015
2016 <para> 2016 <para>
2017 As directed in the general help output, you can get more 2017 As directed in the general help output, you can get more
2018 syntax on a specific command by providing the command 2018 syntax on a specific command by providing the command
2019 name and using <filename>&dash;&dash;help</filename>: 2019 name and using <filename>--help</filename>:
2020 <literallayout class='monospaced'> 2020 <literallayout class='monospaced'>
2021 $ devtool add &dash;&dash;help 2021 $ devtool add --help
2022 usage: devtool add [-h] [&dash;&dash;version VERSION] recipename srctree 2022 usage: devtool add [-h] [--version VERSION] recipename srctree
2023 2023
2024 positional arguments: 2024 positional arguments:
2025 recipename Name for new recipe to add 2025 recipename Name for new recipe to add
2026 srctree Path to external source tree 2026 srctree Path to external source tree
2027 2027
2028 optional arguments: 2028 optional arguments:
2029 -h, &dash;&dash;help show this help message and exit 2029 -h, --help show this help message and exit
2030 &dash;&dash;version VERSION, -V VERSION 2030 --version VERSION, -V VERSION
2031 </literallayout> 2031 </literallayout>
2032 </para> 2032 </para>
2033 </section> 2033 </section>
@@ -2054,7 +2054,7 @@
2054 </literallayout> 2054 </literallayout>
2055 <note> 2055 <note>
2056 For complete syntax, use the 2056 For complete syntax, use the
2057 <filename>devtool add &dash;&dash;help</filename> command. 2057 <filename>devtool add --help</filename> command.
2058 </note> 2058 </note>
2059 </para> 2059 </para>
2060 2060
@@ -2112,7 +2112,7 @@
2112 </literallayout> 2112 </literallayout>
2113 <note> 2113 <note>
2114 For complete syntax, use the 2114 For complete syntax, use the
2115 <filename>devtool create-workspace &dash;&dash;help</filename> command. 2115 <filename>devtool create-workspace --help</filename> command.
2116 </note> 2116 </note>
2117 </para> 2117 </para>
2118 2118
@@ -2162,7 +2162,7 @@
2162 </literallayout> 2162 </literallayout>
2163 <note> 2163 <note>
2164 For complete syntax, use the 2164 For complete syntax, use the
2165 <filename>devtool modify &dash;&dash;help</filename> command. 2165 <filename>devtool modify --help</filename> command.
2166 </note> 2166 </note>
2167 </para> 2167 </para>
2168 </section> 2168 </section>
@@ -2182,7 +2182,7 @@
2182 layer before running the <filename>reset</filename> command. 2182 layer before running the <filename>reset</filename> command.
2183 <note> 2183 <note>
2184 For complete syntax, use the 2184 For complete syntax, use the
2185 <filename>devtool reset &dash;&dash;help</filename> command. 2185 <filename>devtool reset --help</filename> command.
2186 </note> 2186 </note>
2187 </para> 2187 </para>
2188 </section> 2188 </section>
@@ -2208,7 +2208,7 @@
2208 </literallayout> 2208 </literallayout>
2209 <note> 2209 <note>
2210 For complete syntax, use the 2210 For complete syntax, use the
2211 <filename>devtool update-recipe &dash;&dash;help</filename> command. 2211 <filename>devtool update-recipe --help</filename> command.
2212 </note> 2212 </note>
2213 </para> 2213 </para>
2214 </section> 2214 </section>
@@ -2225,7 +2225,7 @@
2225 </literallayout> 2225 </literallayout>
2226 <note> 2226 <note>
2227 For complete syntax, use the 2227 For complete syntax, use the
2228 <filename>devtool update-recipe &dash;&dash;help</filename> command. 2228 <filename>devtool update-recipe --help</filename> command.
2229 </note> 2229 </note>
2230 Building your software using <filename>build</filename> is 2230 Building your software using <filename>build</filename> is
2231 identical to using BitBake to build the software. 2231 identical to using BitBake to build the software.
@@ -2246,7 +2246,7 @@
2246 <filename>user@hostname[:destdir]</filename>. 2246 <filename>user@hostname[:destdir]</filename>.
2247 <note> 2247 <note>
2248 For complete syntax, use the 2248 For complete syntax, use the
2249 <filename>devtool deploy-target &dash;&dash;help</filename> command. 2249 <filename>devtool deploy-target --help</filename> command.
2250 </note> 2250 </note>
2251 </para> 2251 </para>
2252 </section> 2252 </section>
@@ -2269,7 +2269,7 @@
2269 <filename>user@hostname</filename>. 2269 <filename>user@hostname</filename>.
2270 <note> 2270 <note>
2271 For complete syntax, use the 2271 For complete syntax, use the
2272 <filename>devtool undeploy-target &dash;&dash;help</filename> command. 2272 <filename>devtool undeploy-target --help</filename> command.
2273 </note> 2273 </note>
2274 </para> 2274 </para>
2275 </section> 2275 </section>
@@ -2330,7 +2330,7 @@
2330 <literallayout class='monospaced'> 2330 <literallayout class='monospaced'>
2331 $ bitbake -c compile -f <replaceable>package</replaceable> 2331 $ bitbake -c compile -f <replaceable>package</replaceable>
2332 </literallayout> 2332 </literallayout>
2333 The <filename>-f</filename> or <filename>&dash;&dash;force</filename> 2333 The <filename>-f</filename> or <filename>--force</filename>
2334 option forces the specified task to execute. 2334 option forces the specified task to execute.
2335 If you find problems with your code, you can just keep editing and 2335 If you find problems with your code, you can just keep editing and
2336 re-testing iteratively until things work as expected. 2336 re-testing iteratively until things work as expected.
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index d072ecfa0e..3dc141c552 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -1014,7 +1014,7 @@
1014 The <filename>buildhistory-diff</filename> and 1014 The <filename>buildhistory-diff</filename> and
1015 <filename>buildhistory-collect-srcrevs</filename> 1015 <filename>buildhistory-collect-srcrevs</filename>
1016 utilities have improved command-line handling. 1016 utilities have improved command-line handling.
1017 Use the <filename>&dash;&dash;help</filename> option for 1017 Use the <filename>--help</filename> option for
1018 each utility for more information on the new syntax. 1018 each utility for more information on the new syntax.
1019 </para></listitem> 1019 </para></listitem>
1020 </itemizedlist> 1020 </itemizedlist>
@@ -1730,7 +1730,7 @@
1730 The minimum 1730 The minimum
1731 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required 1731 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required
1732 on the build host is now 1.7.8 because the 1732 on the build host is now 1.7.8 because the
1733 <filename>&dash;&dash;list</filename> option is now required by 1733 <filename>--list</filename> option is now required by
1734 BitBake's Git fetcher. 1734 BitBake's Git fetcher.
1735 As always, if your host distribution does not provide a version of 1735 As always, if your host distribution does not provide a version of
1736 Git that meets this requirement, you can use the 1736 Git that meets this requirement, you can use the
@@ -1770,7 +1770,7 @@
1770 class instead of the <filename>autotools</filename> class. 1770 class instead of the <filename>autotools</filename> class.
1771 </para></listitem> 1771 </para></listitem>
1772 <listitem><para><emphasis> 1772 <listitem><para><emphasis>
1773 The <filename>&dash;&dash;foreign</filename> option is 1773 The <filename>--foreign</filename> option is
1774 no longer passed to <filename>automake</filename> when 1774 no longer passed to <filename>automake</filename> when
1775 running <filename>autoconf</filename>:</emphasis> 1775 running <filename>autoconf</filename>:</emphasis>
1776 This option tells <filename>automake</filename> that a 1776 This option tells <filename>automake</filename> that a
diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml
index 871cd294f6..43cb26db4c 100644
--- a/documentation/ref-manual/ref-qa-checks.xml
+++ b/documentation/ref-manual/ref-qa-checks.xml
@@ -894,7 +894,7 @@ can be found then it should be implemented. I can't find one at the moment.
894 and there is another option that should be used instead. 894 and there is another option that should be used instead.
895 If you are unsure, consult the upstream build 895 If you are unsure, consult the upstream build
896 documentation, the 896 documentation, the
897 <filename>./configure &dash;&dash;help</filename> output, 897 <filename>./configure --help</filename> output,
898 and the upstream change log or release notes. 898 and the upstream change log or release notes.
899 Once you have worked out what the appropriate 899 Once you have worked out what the appropriate
900 change is, you can update 900 change is, you can update