summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-03-06 10:49:09 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-03-22 17:08:42 +0000
commita865315674c204a1483b398832588521c8f5ea36 (patch)
treeb2e914a124631b144feceda596573b4c6817df06 /documentation
parent89b6819fdb76415dce35a97f28ff2103cdf8dc6e (diff)
downloadpoky-a865315674c204a1483b398832588521c8f5ea36.tar.gz
dev-manual: applied review comments to create own distro
These changes are basically Paul Eggleton's review comments. (From yocto-docs rev: bb92dbb968013952c4308b9aeed48223f49c866d) 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.xml34
1 files changed, 18 insertions, 16 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 073897378c..1db35c6d7d 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2020,9 +2020,10 @@
2020 When you build a Linux Yocto image using the Yocto Project and 2020 When you build a Linux Yocto image using the Yocto Project and
2021 do not alter any distribution 2021 do not alter any distribution
2022 <link linkend='metadata'>Metadata</link>, you are creating a 2022 <link linkend='metadata'>Metadata</link>, you are creating a
2023 Poky Distribution. 2023 Poky distribution.
2024 If you do not want a Poky Distribution, you can take steps to 2024 If you wish to gain more control over package alternative
2025 create your own distribution. 2025 selections, compile-time options, and other low-level
2026 configuration, you can create your own distribution.
2026 </para> 2027 </para>
2027 2028
2028 <para> 2029 <para>
@@ -2039,28 +2040,29 @@
2039 layer for configuration and code. 2040 layer for configuration and code.
2040 Using your own layer as compared to just placing 2041 Using your own layer as compared to just placing
2041 configurations in a <filename>local.conf</filename> 2042 configurations in a <filename>local.conf</filename>
2042 configuration file makes it easier to reproduce your 2043 configuration file makes it easier to reproduce the same
2043 distribution when using multiple build machines. 2044 build configuration when using multiple build machines.
2044 </para></listitem> 2045 </para></listitem>
2045 <listitem><para><emphasis>Create the Distribution Configuration File:</emphasis> 2046 <listitem><para><emphasis>Create the Distribution Configuration File:</emphasis>
2046 The distribution configuration file needs to be created in 2047 The distribution configuration file needs to be created in
2047 the <filename>conf/distro</filename> directory of your 2048 the <filename>conf/distro</filename> directory of your
2048 layer. 2049 layer.
2049 You need to name it using your distribution name 2050 You need to name it using your distribution name
2050 (e.g. <filename>mydistro.conf</filename>.</para> 2051 (e.g. <filename>mydistro.conf</filename>).</para>
2051 <para>You can split out parts of your configuration file 2052 <para>You can split out parts of your configuration file
2052 into include file and then "require" them from within 2053 into include file and then "require" them from within
2053 your distribution configuration file. 2054 your distribution configuration file.
2054 Be sure to place the include files in the 2055 Be sure to place the include files in the
2055 <filename>conf/distro/include</filename> directory of 2056 <filename>conf/distro/include</filename> directory of
2056 your layer. 2057 your layer.
2057 Common include files select the desired version and 2058 A common example usage of include files would be to
2058 revisions for individual recipes. 2059 separate out the selection of desired version and revisions
2060 for individual recipes.
2059 <tip> 2061 <tip>
2060 If you want to base your distribution configuration file 2062 If you want to base your distribution configuration file
2061 on the very basic configuration from OE-Core, you 2063 on the very basic configuration from OE-Core, you
2062 can "require" 2064 can "require"
2063 <filename>require conf/distro/defaultsetup.conf</filename>. 2065 <filename>conf/distro/defaultsetup.conf</filename>.
2064 Alternatively, you can create a distribution 2066 Alternatively, you can create a distribution
2065 configuration file from scratch using the 2067 configuration file from scratch using the
2066 <filename>defaultsetup.conf</filename> file 2068 <filename>defaultsetup.conf</filename> file
@@ -2072,19 +2074,19 @@
2072 <literallayout class='monospaced'> 2074 <literallayout class='monospaced'>
2073 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME'><filename>DISTRO_NAME</filename></ulink> [required] 2075 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME'><filename>DISTRO_NAME</filename></ulink> [required]
2074 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></ulink> [required] 2076 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></ulink> [required]
2075 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink> 2077 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink> [required if creating from scratch]
2076 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RDEPENDS'><filename>DISTRO_EXTRA_RDEPENDS</filename></ulink> 2078 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RDEPENDS'><filename>DISTRO_EXTRA_RDEPENDS</filename></ulink> [optional]
2077 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RRECOMMENDS'><filename>DISTRO_EXTRA_RRECOMMENDS</filename></ulink> 2079 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RRECOMMENDS'><filename>DISTRO_EXTRA_RRECOMMENDS</filename></ulink> [optional]
2078 <ulink url='&YOCTO_DOCS_REF_URL;#var-TCLIBC'><filename>TCLIBC</filename></ulink> 2080 <ulink url='&YOCTO_DOCS_REF_URL;#var-TCLIBC'><filename>TCLIBC</filename></ulink> [required if creating from scratch]
2079 <ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></ulink>
2080 <ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink>
2081 </literallayout></para></listitem> 2081 </literallayout></para></listitem>
2082 <listitem><para><emphasis>Provide Miscellaneous Variables:</emphasis> 2082 <listitem><para><emphasis>Provide Miscellaneous Variables:</emphasis>
2083 Be sure to define any other variable for which you want to 2083 Be sure to define any other variable for which you want to
2084 create a default or enforce as part of the distribution 2084 create a default or enforce as part of the distribution
2085 configuration. 2085 configuration.
2086 You can include nearly any variable from the 2086 You can include nearly any variable from the
2087 <filename>local.conf</filename> file.</para></listitem> 2087 <filename>local.conf</filename> file.
2088 The variables you use are not limited to the list in the
2089 previous bulletted item.</para></listitem>
2088 <listitem><para><emphasis>Point to Your Distribution Configuration File:</emphasis> 2090 <listitem><para><emphasis>Point to Your Distribution Configuration File:</emphasis>
2089 In your <filename>local.conf</filename> file in the 2091 In your <filename>local.conf</filename> file in the
2090 <link linkend='build-directory'>Build Directory</link>, 2092 <link linkend='build-directory'>Build Directory</link>,