summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-03-18 11:56:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-03-19 12:38:18 +0000
commit083d4a36a2913e910b05228ff698bebfceb56c77 (patch)
treeddb2335fcc4e4fb7f6b07e56afaf79c3e00def7b /documentation
parent1345195137badd98a5fdbd6e96e2dfe68862b948 (diff)
downloadast2050-yocto-poky-083d4a36a2913e910b05228ff698bebfceb56c77.zip
ast2050-yocto-poky-083d4a36a2913e910b05228ff698bebfceb56c77.tar.gz
dev-manual: Added new section on changing default image hostname
Fixes [YOCTO #7417] New section to address how the user can change the devalt image hostname written out to /etc/hostname. (From yocto-docs rev: 4ac6bc05947e56106aafcc6f9aef93bd93293fba) 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.xml184
1 files changed, 120 insertions, 64 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 9030b96..ba74e15 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -741,13 +741,13 @@
...
DESCRIPTION = "A useful utility"
...
- EXTRA_OECONF = "--enable-something"
+ EXTRA_OECONF = "&dash;&dash;enable-something"
...
#### bbappended from meta-anotherlayer ####
DESCRIPTION = "Customized utility"
- EXTRA_OECONF += "--enable-somethingelse"
+ EXTRA_OECONF += "&dash;&dash;enable-somethingelse"
</literallayout>
Ideally, you would tidy up these utilities as
follows:
@@ -755,7 +755,7 @@
...
DESCRIPTION = "Customized utility"
...
- EXTRA_OECONF = "--enable-something --enable-somethingelse"
+ EXTRA_OECONF = "&dash;&dash;enable-something &dash;&dash;enable-somethingelse"
...
</literallayout></para></listitem>
</itemizedlist></para></listitem>
@@ -1170,6 +1170,61 @@
For other forms of image dependencies see the other areas of this section.
</para>
</section>
+
+ <section id='usingpoky-extend-customimage-image-name'>
+ <title>Customizing an Image Hostname</title>
+
+ <para>
+ By default the configured hostname (i.e.
+ <filename>/etc/hostname</filename>) in an image is the
+ same as the machine name.
+ For example, if
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
+ equals "qemux86", the configured hostname written to
+ <filename>/etc/hostname</filename> is "qemux86".
+ </para>
+
+ <para>
+ You can customize this name by altering the value of the
+ "hostname" variable in the base-files recipe using either
+ an append file or a configuration file.
+ <note>
+ Setting the variable to "" causes no hostname to be
+ written to <filename>/etc/hostname</filename>.
+ </note>
+ Use the following in an append file:
+ <literallayout class='monospaced'>
+ hostname="myhostname"
+ </literallayout>
+ Use the following in a configuration file:
+ <literallayout class='monospaced'>
+ hostname_pn-base-files = "myhostname"
+ </literallayout>
+ </para>
+
+ <para>
+ Changing the default value of the variable "hostname" can be
+ useful in certain situations.
+ For example, suppose you need to do extensive testing on an
+ image and you would like to easily identify the image
+ under test from existing images with typical default
+ hostnames.
+ In this situation, you could change the default hostname to
+ "testme", which results in all the images using the name
+ "testme".
+ Once testing is complete and you do not need to rebuild the
+ image for test any longer, you can easily reset the default
+ hostname.
+ </para>
+
+ <para>
+ Another point of interest is that if you leave the variable
+ "hostname" unset, the image will have no default hostname
+ in the filesystem.
+ This condition is suitable for environments that use
+ dynamic hostnames such as virtual machines.
+ </para>
+ </section>
</section>
<section id='new-recipe-writing-a-new-recipe'>
@@ -2275,7 +2330,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 &dash;&dash;help</filename> and look for
the options you need to set.</para></listitem>
</itemizedlist>
</para>
@@ -2298,7 +2353,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 &dash;&dash;help</filename> command within
<filename>${S}</filename> or consult the software's upstream
documentation.
</para>
@@ -3780,7 +3835,7 @@
or by entering the command with a help argument as follows:
<literallayout class='monospaced'>
$ wic -h
- $ wic --help
+ $ wic &dash;&dash;help
</literallayout>
</para>
@@ -3796,7 +3851,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 &dash;&dash;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
@@ -3866,38 +3921,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>, &dash;&dash;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>, &dash;&dash;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>, &dash;&dash;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>, &dash;&dash;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>, &dash;&dash;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>, &dash;&dash;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>, &dash;&dash;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, &dash;&dash;skip-build-check
Skips the build check.
- -D, --debug
+ -D, &dash;&dash;debug
Output debug information.
</literallayout>
<note>
@@ -4107,13 +4162,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>&dash;&dash;ondisk sda</filename>"
+ to "<filename>&dash;&dash;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 &dash;&dash;source bootimg-pcbios &dash;&dash;ondisk sdb &dash;&dash;label boot &dash;&dash;active &dash;&dash;align 1024
+ part / &dash;&dash;source rootfs &dash;&dash;ondisk sdb &dash;&dash;fstype=ext3 &dash;&dash;label platform &dash;&dash;align 1024
</literallayout>
Once the lines are changed, the example generates the
<filename>directdisksdb</filename> image.
@@ -4200,11 +4255,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 &dash;&dash;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
+ &dash;&dash;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 \
+ &dash;&dash;native-sysroot /home/trz/yocto/yocto-image/build/tmp/sysroots/x86_64-linux
Creating image(s)...
@@ -4247,7 +4302,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>&dash;&dash;source</filename> keyword to a
particular plugin implementation that populates a
corresponding partition.
</para>
@@ -4276,11 +4331,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>&dash;&dash;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 &dash;&dash;source bootimg-pcbios ...
</literallayout>
The methods defined as class members of the plugin
having the matching <filename>bootimg-pcbios.name</filename>
@@ -4290,7 +4345,7 @@
<para>
To be more concrete, here is the plugin definition that
matches a
- <filename>--source bootimg-pcbios</filename> usage,
+ <filename>&dash;&dash;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
@@ -4312,7 +4367,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>&dash;&dash;source</filename> plugins.
Any methods not implemented by a
<filename>SourcePlugin</filename> subclass inherit the
implementations present in the
@@ -4444,13 +4499,13 @@
<para>
Following are the supported options:
<itemizedlist>
- <listitem><para><emphasis><filename>--size</filename>:</emphasis>
+ <listitem><para><emphasis><filename>&dash;&dash;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>&dash;&dash;source</filename>.</para></listitem>
+ <listitem><para><emphasis><filename>&dash;&dash;source</filename>:</emphasis>
This option is a
<filename>wic</filename>-specific option that
names the source of the data that populates
@@ -4462,7 +4517,7 @@
"<link linkend='openembedded-kickstart-plugins'>Plugins</link>"
section.</para>
<para>If you use
- <filename>--source rootfs</filename>,
+ <filename>&dash;&dash;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
@@ -4472,14 +4527,14 @@
option.
The filesystem type used to create the
partition is driven by the value of the
- <filename>--fstype</filename> option
+ <filename>&dash;&dash;fstype</filename> option
specified for the partition.
See the entry on
- <filename>--fstype</filename> that
+ <filename>&dash;&dash;fstype</filename> that
follows for more information.
</para>
<para>If you use
- <filename>--source <replaceable>plugin-name</replaceable></filename>,
+ <filename>&dash;&dash;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
@@ -4492,10 +4547,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>&dash;&dash;ondisk</filename> or <filename>&dash;&dash;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>&dash;&dash;fstype</filename>:</emphasis>
Sets the file system type for the partition.
Valid values are:
<itemizedlist>
@@ -4512,7 +4567,7 @@
<listitem><para><filename>swap</filename>
</para></listitem>
</itemizedlist></para></listitem>
- <listitem><para><emphasis><filename>--fsoptions</filename>:</emphasis>
+ <listitem><para><emphasis><filename>&dash;&dash;fsoptions</filename>:</emphasis>
Specifies a free-form string of options to be
used when mounting the filesystem.
This string will be copied into the
@@ -4522,15 +4577,15 @@
If not specified, the default string
is "defaults".
</para></listitem>
- <listitem><para><emphasis><filename>--label label</filename>:</emphasis>
+ <listitem><para><emphasis><filename>&dash;&dash;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>&dash;&dash;active</filename>:</emphasis>
Marks the partition as active.</para></listitem>
- <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis>
+ <listitem><para><emphasis><filename>&dash;&dash;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>
@@ -4547,17 +4602,17 @@
<note>
Bootloader functionality and boot partitions are
implemented by the various
- <filename>--source</filename>
+ <filename>&dash;&dash;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>&dash;&dash;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>&dash;&dash;append</filename>:</emphasis>
Specifies kernel parameters.
These parameters will be added to the syslinux
<filename>APPEND</filename> or
@@ -5826,7 +5881,8 @@
<para>The <filename>merge_config.sh</filename> script is
part of the Linux Yocto kernel Git repositories
(i.e. <filename>linux-yocto-3.14</filename>,
- <filename>linux-yocto-3.19</filename>, and so forth)
+ <filename>linux-yocto-3.10</filename>,
+ <filename>linux-yocto-3.8</filename>, and so forth)
in the
<filename>scripts/kconfig</filename> directory.</para>
<para>For more information on configuration fragments,
@@ -6484,7 +6540,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 &dash;&dash;host <replaceable>ip</replaceable> &dash;&dash;port <replaceable>port</replaceable> &dash;&dash;start
</literallayout>
In addition to hand-starting the service, you need to
update the <filename>local.conf</filename> file of each
@@ -7136,9 +7192,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 &dash;&dash;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 &dash;&dash;add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
</literallayout>
Also from the target machine, fetch the repository
information using this command:
@@ -8588,13 +8644,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
+ "&dash;&dash;deploy-dir <replaceable>path</replaceable>" as
follows:
<literallayout class='monospaced'>
- ./runexported.py --deploy-dir /new/path/on/this/machine testdata.json
+ ./runexported.py &dash;&dash;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>&dash;&dash;help</filename>.
</para>
</section>
@@ -9054,7 +9110,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 &dash;&dash;no-print-directory all-am
| /bin/mkdir -p include/near
| /bin/mkdir -p include/near
| /bin/mkdir -p include/near
@@ -9095,7 +9151,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 &dash;&dash;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/
@@ -9170,7 +9226,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 &dash;&dash;sysroot=/home/scott-lenovo/......
.
.
.
@@ -9565,14 +9621,14 @@
<para>
<literallayout class='monospaced'>
- # opcontrol --reset
- # opcontrol --start --separate=lib --no-vmlinux -c 5
+ # opcontrol &dash;&dash;reset
+ # opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5
.
.
[do whatever is being profiled]
.
.
- # opcontrol --stop
+ # opcontrol &dash;&dash;stop
$ opreport -cl
</literallayout>
</para>
@@ -9585,7 +9641,7 @@
five levels deep.
<note>
To profile the kernel, you would specify the
- <filename>--vmlinux=/path/to/vmlinux</filename> option.
+ <filename>&dash;&dash;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>
@@ -9648,7 +9704,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>&dash;&dash;port</filename> command-line
option.
</note>
</para>
@@ -9738,14 +9794,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 &dash;&dash;reset
+ # opcontrol &dash;&dash;start &dash;&dash;separate=lib &dash;&dash;no-vmlinux -c 5
.
.
[do whatever is being profiled]
.
.
- # opcontrol --stop
+ # opcontrol &dash;&dash;stop
# oparchive -o my_archive
</literallayout>
</para>
OpenPOWER on IntegriCloud