diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 5a3901d9c5..01ee2da8d0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -738,13 +738,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" Ideally, you would tidy up these utilities as follows: @@ -752,7 +752,7 @@ ... DESCRIPTION = "Customized utility" ... - EXTRA_OECONF = "--enable-something --enable-somethingelse" + EXTRA_OECONF = "‐‐enable-something ‐‐enable-somethingelse" ... @@ -2110,7 +2110,7 @@ configure script with the appropriate options. For the case involving a custom configure script, you would run - ./configure --help and look for + ./configure ‐‐help and look for the options you need to set. @@ -2133,7 +2133,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 - ./configure --help command within + ./configure ‐‐help command within ${S} or consult the software's upstream documentation. @@ -3588,7 +3588,7 @@ or by entering the command with a help argument as follows: $ wic -h - $ wic --help + $ wic ‐‐help @@ -3674,38 +3674,38 @@ your own custom file or use a file from a set of existing files as described by further options. - -o OUTDIR, --outdir=OUTDIR + -o OUTDIR, ‐‐outdir=OUTDIR The name of a directory in which to create image. - -i PROPERTIES_FILE, --infile=PROPERTIES_FILE + -i PROPERTIES_FILE, ‐‐infile=PROPERTIES_FILE The name of a file containing the values for image properties as a JSON file. - -e IMAGE_NAME, --image-name=IMAGE_NAME + -e IMAGE_NAME, ‐‐image-name=IMAGE_NAME The name of the image from which to use the artifacts (e.g. core-image-sato). - -r ROOTFS_DIR, --rootfs-dir=ROOTFS_DIR + -r ROOTFS_DIR, ‐‐rootfs-dir=ROOTFS_DIR The path to the /rootfs directory to use as the .wks rootfs source. - -b BOOTIMG_DIR, --bootimg-dir=BOOTIMG_DIR + -b BOOTIMG_DIR, ‐‐bootimg-dir=BOOTIMG_DIR The path to the directory containing the boot artifacts (e.g. /EFI or /syslinux) to use as the .wks bootimg source. - -k KERNEL_DIR, --kernel-dir=KERNEL_DIR + -k KERNEL_DIR, ‐‐kernel-dir=KERNEL_DIR The path to the directory containing the kernel to use in the .wks boot image. - -n NATIVE_SYSROOT, --native-sysroot=NATIVE_SYSROOT + -n NATIVE_SYSROOT, ‐‐native-sysroot=NATIVE_SYSROOT The path to the native sysroot containing the tools to use to build the image. - -p, --skip-build-check + -p, ‐‐skip-build-check Skips the build check. - -D, --debug + -D, ‐‐debug Output debug information. @@ -3915,13 +3915,13 @@ Next, the example modifies the directdisksdb.wks file and changes all - instances of "--ondisk sda" - to "--ondisk sdb". + instances of "‐‐ondisk sda" + to "‐‐ondisk sdb". The example changes the following two lines and leaves the remaining lines untouched: - 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 Once the lines are changed, the example generates the directdisksdb image. @@ -4008,11 +4008,11 @@ somewhere other than the default /var/tmp/wic directory: - $ 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)... @@ -4088,7 +4088,7 @@ that partition. For example, if the partition is set up as follows: - part /boot --source bootimg-pcbios ... + part /boot ‐‐source bootimg-pcbios ... The methods defined as class members of the plugin having the matching bootimg-pcbios.name @@ -4245,13 +4245,13 @@ Following are the supported options: - --size: + ‐‐size: 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 - --source. - --source: + ‐‐source. + ‐‐source: This option is a wic-specific option that names the source of the data that populates @@ -4293,10 +4293,10 @@ filesystem type end up being are dependent on the given plugin implementation. - --ondisk or --ondrive: + ‐‐ondisk or ‐‐ondrive: Forces the partition to be created on a particular disk. - --fstype: + ‐‐fstype: Sets the file system type for the partition. Valid values are: @@ -4323,15 +4323,15 @@ If not specified, the default string is "defaults". - --label label: + ‐‐label label: 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. - --active: + ‐‐active: Marks the partition as active. - --align (in KBytes): + ‐‐align (in KBytes): This option is a wic-specific option that says to start a partition on an x KBytes boundary. @@ -4361,11 +4361,11 @@ supported, results can be unpredictable. - --timeout: + ‐‐timeout: Specifies the number of seconds before the bootloader times out and boots the default option. - --append: + ‐‐append: Specifies kernel parameters. These parameters will be added to the syslinux APPEND or @@ -6803,9 +6803,9 @@ Gateways via their Web Interfaces" Given this example, issue the following commands on the target: - # 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 Also from the target machine, fetch the repository information using this command: @@ -8008,9 +8008,9 @@ Gateways via their Web Interfaces" are enabled). Consequently, running the tests on other machine means that you have to move the contents and call - runexported with "--deploy-dir PATH: - ./runexported.py --deploy-dir /new/path/on/this/machine testdata.json - runexported.py accepts other arguments as well, see --help. + runexported with "‐‐deploy-dir PATH: + ./runexported.py ‐‐deploy-dir /new/path/on/this/machine testdata.json + runexported.py accepts other arguments as well, see ‐‐help. @@ -8476,7 +8476,7 @@ Gateways via their Web Interfaces" | 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 @@ -8517,7 +8517,7 @@ Gateways via their Web Interfaces" | 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/ @@ -8592,7 +8592,7 @@ Gateways via their Web Interfaces" Here is some abbreviated, sample output with the missing dependency clearly visible at the end: - i586-poky-linux-gcc -m32 -march=i586 --sysroot=/home/scott-lenovo/...... + i586-poky-linux-gcc -m32 -march=i586 ‐‐sysroot=/home/scott-lenovo/...... . . . @@ -8985,14 +8985,14 @@ Gateways via their Web Interfaces" - # 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 @@ -9005,7 +9005,7 @@ Gateways via their Web Interfaces" five levels deep. To profile the kernel, you would specify the - --vmlinux=/path/to/vmlinux option. + ‐‐vmlinux=/path/to/vmlinux option. The vmlinux file is usually in the source directory in the /boot/ directory and must match the running kernel. @@ -9068,7 +9068,7 @@ Gateways via their Web Interfaces" With this connection, you just need to run "oprofile-server" on the device. By default, OProfile listens on port 4224. - You can change the port using the --port command-line + You can change the port using the ‐‐port command-line option. @@ -9158,14 +9158,14 @@ Gateways via their Web Interfaces" If network access to the target is unavailable, you can generate an archive for processing in oprofile-viewer as follows: - # 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