diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2015-04-27 08:15:56 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2015-04-28 16:31:00 +0100 |
| commit | 320a2206e0b1a745f0c9d3557c59e49779a96a7e (patch) | |
| tree | 61bc2e65db9fce8796db518fb2b49ee67d734faa /documentation | |
| parent | e4f3cf8950106bd420e09f463f11c4e607462126 (diff) | |
| download | ast2050-yocto-poky-320a2206e0b1a745f0c9d3557c59e49779a96a7e.zip ast2050-yocto-poky-320a2206e0b1a745f0c9d3557c59e49779a96a7e.tar.gz | |
dev-manual; ref-manual: Fixed ‐ issue
Fixes [YOCTO #7386]
Apparently the "‐" ENTITY used throughout the YP manual set to
get literal "-" characters in example commands renders into a unicode
that is not a dash. This results in users getting errors if they
attempt to cut-and-paste a sample command that uses a "-" character
from the manual into a shell. I have universally replaced all the
"‐" strings in the YP manual set to "-" strings.
(From yocto-docs rev: 1309e124d83fdf3c98be5c3ff1943f1c0d496c20)
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.xml | 126 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 6 |
2 files changed, 66 insertions, 66 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index aeda1fe..7a28176 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -736,13 +736,13 @@ ... DESCRIPTION = "A useful utility" ... - EXTRA_OECONF = "‐‐enable-something" + EXTRA_OECONF = "--enable-something" ... #### bbappended from meta-anotherlayer #### DESCRIPTION = "Customized utility" - EXTRA_OECONF += "‐‐enable-somethingelse" + EXTRA_OECONF += "--enable-somethingelse" </literallayout> Ideally, you would tidy up these utilities as follows: @@ -750,7 +750,7 @@ ... DESCRIPTION = "Customized utility" ... - EXTRA_OECONF = "‐‐enable-something ‐‐enable-somethingelse" + EXTRA_OECONF = "--enable-something --enable-somethingelse" ... </literallayout></para></listitem> </itemizedlist></para></listitem> @@ -2322,7 +2322,7 @@ configure script with the appropriate options.</para> <para>For the case involving a custom configure script, you would run - <filename>./configure ‐‐help</filename> and look for + <filename>./configure --help</filename> and look for the options you need to set.</para></listitem> </itemizedlist> </para> @@ -2345,7 +2345,7 @@ configure script as needed. For reference information on configure options specific to the software you are building, you can consult the output of the - <filename>./configure ‐‐help</filename> command within + <filename>./configure --help</filename> command within <filename>${S}</filename> or consult the software's upstream documentation. </para> @@ -3827,7 +3827,7 @@ or by entering the command with a help argument as follows: <literallayout class='monospaced'> $ wic -h - $ wic ‐‐help + $ wic --help </literallayout> </para> @@ -3843,7 +3843,7 @@ <para> You can also get detailed help on a number of topics from the help system. - The output of <filename>wic ‐‐help</filename> + The output of <filename>wic --help</filename> displays a list of available help topics under a "Help topics" heading. You can have the help system display the help text for @@ -3913,38 +3913,38 @@ your own custom file or use a file from a set of existing files as described by further options. - -o <replaceable>OUTDIR</replaceable>, ‐‐outdir=<replaceable>OUTDIR</replaceable> + -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable> The name of a directory in which to create image. - -i <replaceable>PROPERTIES_FILE</replaceable>, ‐‐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 properties as a JSON file. - -e <replaceable>IMAGE_NAME</replaceable>, ‐‐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 (e.g. <filename>core-image-sato</filename>). - -r <replaceable>ROOTFS_DIR</replaceable>, ‐‐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 <filename>.wks</filename> rootfs source. - -b <replaceable>BOOTIMG_DIR</replaceable>, ‐‐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 (e.g. <filename>/EFI</filename> or <filename>/syslinux</filename>) to use as the <filename>.wks</filename> bootimg source. - -k <replaceable>KERNEL_DIR</replaceable>, ‐‐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 in the <filename>.wks</filename> boot image. - -n <replaceable>NATIVE_SYSROOT</replaceable>, ‐‐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 to build the image. - -s, ‐‐skip-build-check + -s, --skip-build-check Skips the build check. - -D, ‐‐debug + -D, --debug Output debug information. </literallayout> <note> @@ -4154,13 +4154,13 @@ </literallayout> Next, the example modifies the <filename>directdisksdb.wks</filename> file and changes all - instances of "<filename>‐‐ondisk sda</filename>" - to "<filename>‐‐ondisk sdb</filename>". + instances of "<filename>--ondisk sda</filename>" + to "<filename>--ondisk sdb</filename>". The example changes the following two lines and leaves the remaining lines untouched: <literallayout class='monospaced'> - part /boot ‐‐source bootimg-pcbios ‐‐ondisk sdb ‐‐label boot ‐‐active ‐‐align 1024 - part / ‐‐source rootfs ‐‐ondisk sdb ‐‐fstype=ext3 ‐‐label platform ‐‐align 1024 + part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024 + part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 </literallayout> Once the lines are changed, the example generates the <filename>directdisksdb</filename> image. @@ -4247,11 +4247,11 @@ somewhere other than the default <filename>/var/tmp/wic</filename> directory: <literallayout class='monospaced'> - $ wic create ~/test.wks -o /home/trz/testwic ‐‐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 \ - ‐‐bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \ - ‐‐kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \ - ‐‐native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux + --bootimg-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/share \ + --kernel-dir /home/trz/yocto/yocto-image/build/tmp/sysroots/crownbay-noemgd/usr/src/kernel \ + --native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux Creating image(s)... @@ -4294,7 +4294,7 @@ partitions. The plugins provide a mechanism for mapping values specified in <filename>.wks</filename> files using the - <filename>‐‐source</filename> keyword to a + <filename>--source</filename> keyword to a particular plugin implementation that populates a corresponding partition. </para> @@ -4323,11 +4323,11 @@ When the <filename>wic</filename> implementation needs to invoke a partition-specific implementation, it looks for the plugin that has the same name as the - <filename>‐‐source</filename> parameter given to + <filename>--source</filename> parameter given to that partition. For example, if the partition is set up as follows: <literallayout class='monospaced'> - part /boot ‐‐source bootimg-pcbios ... + part /boot --source bootimg-pcbios ... </literallayout> The methods defined as class members of the plugin having the matching <filename>bootimg-pcbios.name</filename> @@ -4337,7 +4337,7 @@ <para> To be more concrete, here is the plugin definition that matches a - <filename>‐‐source bootimg-pcbios</filename> usage, + <filename>--source bootimg-pcbios</filename> usage, along with an example method called by the <filename>wic</filename> implementation when it needs to invoke an implementation-specific @@ -4359,7 +4359,7 @@ The <filename>SourcePlugin</filename> class defines the following methods, which is the current set of methods that can be implemented or overridden by - <filename>‐‐source</filename> plugins. + <filename>--source</filename> plugins. Any methods not implemented by a <filename>SourcePlugin</filename> subclass inherit the implementations present in the @@ -4491,13 +4491,13 @@ <para> Following are the supported options: <itemizedlist> - <listitem><para><emphasis><filename>‐‐size</filename>:</emphasis> + <listitem><para><emphasis><filename>--size</filename>:</emphasis> The minimum partition size in MBytes. Specify an integer value such as 500. Do not append the number with "MB". You do not need this option if you use - <filename>‐‐source</filename>.</para></listitem> - <listitem><para><emphasis><filename>‐‐source</filename>:</emphasis> + <filename>--source</filename>.</para></listitem> + <listitem><para><emphasis><filename>--source</filename>:</emphasis> This option is a <filename>wic</filename>-specific option that names the source of the data that populates @@ -4509,7 +4509,7 @@ "<link linkend='openembedded-kickstart-plugins'>Plugins</link>" section.</para> <para>If you use - <filename>‐‐source rootfs</filename>, + <filename>--source rootfs</filename>, <filename>wic</filename> creates a partition as large as needed and to fill it with the contents of the root filesystem pointed to by the @@ -4519,14 +4519,14 @@ option. The filesystem type used to create the partition is driven by the value of the - <filename>‐‐fstype</filename> option + <filename>--fstype</filename> option specified for the partition. See the entry on - <filename>‐‐fstype</filename> that + <filename>--fstype</filename> that follows for more information. </para> <para>If you use - <filename>‐‐source <replaceable>plugin-name</replaceable></filename>, + <filename>--source <replaceable>plugin-name</replaceable></filename>, <filename>wic</filename> creates a partition as large as needed and fills it with the contents of the partition that is generated by the @@ -4539,10 +4539,10 @@ filesystem type end up being are dependent on the given plugin implementation. </para></listitem> - <listitem><para><emphasis><filename>‐‐ondisk</filename> or <filename>‐‐ondrive</filename>:</emphasis> + <listitem><para><emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis> Forces the partition to be created on a particular disk.</para></listitem> - <listitem><para><emphasis><filename>‐‐fstype</filename>:</emphasis> + <listitem><para><emphasis><filename>--fstype</filename>:</emphasis> Sets the file system type for the partition. Valid values are: <itemizedlist> @@ -4559,7 +4559,7 @@ <listitem><para><filename>swap</filename> </para></listitem> </itemizedlist></para></listitem> - <listitem><para><emphasis><filename>‐‐fsoptions</filename>:</emphasis> + <listitem><para><emphasis><filename>--fsoptions</filename>:</emphasis> Specifies a free-form string of options to be used when mounting the filesystem. This string will be copied into the @@ -4569,15 +4569,15 @@ If not specified, the default string is "defaults". </para></listitem> - <listitem><para><emphasis><filename>‐‐label label</filename>:</emphasis> + <listitem><para><emphasis><filename>--label label</filename>:</emphasis> Specifies the label to give to the filesystem to be made on the partition. If the given label is already in use by another filesystem, a new label is created for the partition.</para></listitem> - <listitem><para><emphasis><filename>‐‐active</filename>:</emphasis> + <listitem><para><emphasis><filename>--active</filename>:</emphasis> Marks the partition as active.</para></listitem> - <listitem><para><emphasis><filename>‐‐align (in KBytes)</filename>:</emphasis> + <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis> This option is a <filename>wic</filename>-specific option that says to start a partition on an x KBytes boundary.</para></listitem> @@ -4594,17 +4594,17 @@ <note> Bootloader functionality and boot partitions are implemented by the various - <filename>‐‐source</filename> + <filename>--source</filename> plugins that implement bootloader functionality. The bootloader command essentially provides a means of modifying bootloader configuration. </note> <itemizedlist> - <listitem><para><emphasis><filename>‐‐timeout</filename>:</emphasis> + <listitem><para><emphasis><filename>--timeout</filename>:</emphasis> Specifies the number of seconds before the bootloader times out and boots the default option. </para></listitem> - <listitem><para><emphasis><filename>‐‐append</filename>:</emphasis> + <listitem><para><emphasis><filename>--append</filename>:</emphasis> Specifies kernel parameters. These parameters will be added to the syslinux <filename>APPEND</filename> or @@ -6529,7 +6529,7 @@ For this scenario, you need to start the PR Service using the <filename>bitbake-prserv</filename> command: <literallayout class='monospaced'> - bitbake-prserv ‐‐host <replaceable>ip</replaceable> ‐‐port <replaceable>port</replaceable> ‐‐start + bitbake-prserv --host <replaceable>ip</replaceable> --port <replaceable>port</replaceable> --start </literallayout> In addition to hand-starting the service, you need to update the <filename>local.conf</filename> file of each @@ -7181,9 +7181,9 @@ Given this example, issue the following commands on the target: <literallayout class='monospaced'> - # smart channel ‐‐add all type=rpm-md baseurl=http://server.name/rpm/all - # smart channel ‐‐add i585 type=rpm-md baseurl=http://server.name/rpm/i586 - # smart channel ‐‐add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86 + # smart channel --add all type=rpm-md baseurl=http://server.name/rpm/all + # smart channel --add i585 type=rpm-md baseurl=http://server.name/rpm/i586 + # smart channel --add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86 </literallayout> Also from the target machine, fetch the repository information using this command: @@ -8633,13 +8633,13 @@ Consequently, running the tests on other machine means that you have to move the contents and call <filename>runexported.py</filename> with - "‐‐deploy-dir <replaceable>path</replaceable>" as + "--deploy-dir <replaceable>path</replaceable>" as follows: <literallayout class='monospaced'> - ./runexported.py ‐‐deploy-dir /new/path/on/this/machine testdata.json + ./runexported.py --deploy-dir /new/path/on/this/machine testdata.json </literallayout> <filename>runexported.py</filename> accepts other arguments - as well as described using <filename>‐‐help</filename>. + as well as described using <filename>--help</filename>. </para> </section> @@ -9099,7 +9099,7 @@ | DEBUG: SITE files ['endian-little', 'bit-32', 'ix86-common', 'common-linux', 'common-glibc', 'i586-linux', 'common'] | DEBUG: Executing shell function do_compile | NOTE: make -j 16 - | make ‐‐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 @@ -9140,7 +9140,7 @@ | 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 | ./src/genbuiltin nfctype1 nfctype2 nfctype3 nfctype4 p2p > src/builtin.h - | i586-poky-linux-gcc -m32 -march=i586 ‐‐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/ 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/ @@ -9215,7 +9215,7 @@ Here is some abbreviated, sample output with the missing dependency clearly visible at the end: <literallayout class='monospaced'> - i586-poky-linux-gcc -m32 -march=i586 ‐‐sysroot=/home/scott-lenovo/...... + i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/...... . . . @@ -9399,14 +9399,14 @@ <para> <literallayout class='monospaced'> - # opcontrol ‐‐reset - # opcontrol ‐‐start ‐‐separate=lib ‐‐no-vmlinux -c 5 + # opcontrol --reset + # opcontrol --start --separate=lib --no-vmlinux -c 5 . . [do whatever is being profiled] . . - # opcontrol ‐‐stop + # opcontrol --stop $ opreport -cl </literallayout> </para> @@ -9419,7 +9419,7 @@ five levels deep. <note> To profile the kernel, you would specify the - <filename>‐‐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 <filename>/boot/</filename> directory and must match the running kernel. </note> @@ -9482,7 +9482,7 @@ With this connection, you just need to run "oprofile-server" on the device. By default, OProfile listens on port 4224. <note> - You can change the port using the <filename>‐‐port</filename> command-line + You can change the port using the <filename>--port</filename> command-line option. </note> </para> @@ -9572,14 +9572,14 @@ If network access to the target is unavailable, you can generate an archive for processing in <filename>oprofile-viewer</filename> as follows: <literallayout class='monospaced'> - # opcontrol ‐‐reset - # opcontrol ‐‐start ‐‐separate=lib ‐‐no-vmlinux -c 5 + # opcontrol --reset + # opcontrol --start --separate=lib --no-vmlinux -c 5 . . [do whatever is being profiled] . . - # opcontrol ‐‐stop + # opcontrol --stop # oparchive -o my_archive </literallayout> </para> diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 3889473..880badd 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -116,19 +116,19 @@ It's useful to have some idea of how the tasks defined by this class work and what they do behind the scenes. <itemizedlist> - <listitem><para><link linkend='ref-tasks-configure'><filename>do_configure</filename></link> ‐ + <listitem><para><link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - Regenerates the configure script (using <filename>autoreconf</filename>) and then launches it with a standard set of arguments used during cross-compilation. You can pass additional parameters to <filename>configure</filename> through the <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable. </para></listitem> - <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> ‐ Runs <filename>make</filename> with + <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - Runs <filename>make</filename> with arguments that specify the compiler and linker. You can pass additional arguments through the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable. </para></listitem> - <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> ‐ Runs <filename>make install</filename> + <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> - Runs <filename>make install</filename> and passes in <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> as <filename>DESTDIR</filename>. |
