diff options
Diffstat (limited to 'docs/usermanual/reference')
| -rw-r--r-- | docs/usermanual/reference/class_autotools.xml | 4 | ||||
| -rw-r--r-- | docs/usermanual/reference/class_binconfig.xml | 4 | ||||
| -rw-r--r-- | docs/usermanual/reference/class_image.xml | 4 | ||||
| -rw-r--r-- | docs/usermanual/reference/class_siteinfo.xml | 8 | ||||
| -rw-r--r-- | docs/usermanual/reference/dirs_install.xml | 2 | ||||
| -rw-r--r-- | docs/usermanual/reference/fakeroot.xml | 4 | ||||
| -rw-r--r-- | docs/usermanual/reference/var_src_uri.xml | 51 |
7 files changed, 49 insertions, 28 deletions
diff --git a/docs/usermanual/reference/class_autotools.xml b/docs/usermanual/reference/class_autotools.xml index a9e1a5721a..248b66a116 100644 --- a/docs/usermanual/reference/class_autotools.xml +++ b/docs/usermanual/reference/class_autotools.xml @@ -12,7 +12,7 @@ <para>The autotools class takes care of all of the details for you. It defines appropriate tasks for <emphasis>configure</emphasis>, <emphasis>compile</emphasis>, <emphasis>stage</emphasis> and - <emphasis>install</emphasis>. At it's simplest adding an inherit for the + <emphasis>install</emphasis>. At its simplest adding an inherit for the autotools class is all that is required. The netcat recipe for example is:<screen>DESCRIPTION = "GNU Netcat" HOMEPAGE = "http://netcat.sourceforge.net" @@ -150,4 +150,4 @@ do_configure() { oe_runconf }</screen></para> </section> -</section>
\ No newline at end of file +</section> diff --git a/docs/usermanual/reference/class_binconfig.xml b/docs/usermanual/reference/class_binconfig.xml index 049f85e1f0..4c60e671f0 100644 --- a/docs/usermanual/reference/class_binconfig.xml +++ b/docs/usermanual/reference/class_binconfig.xml @@ -37,10 +37,10 @@ class.</para> <para>The class will search in source directory, <command>${S}</command>, - and all it's subdirectories, for files that end in + and all its subdirectories, for files that end in <command>-config</command> and process them as described above. All that is required to use the class is the addition of binconfig in an inherit statement:</para> <para><screen>inherit autotools binconfig</screen></para> -</section>
\ No newline at end of file +</section> diff --git a/docs/usermanual/reference/class_image.xml b/docs/usermanual/reference/class_image.xml index b591e9aae2..227f7e1cd0 100644 --- a/docs/usermanual/reference/class_image.xml +++ b/docs/usermanual/reference/class_image.xml @@ -349,10 +349,10 @@ Alias /bogofeed ${DEPLOY_DIR} <command>deploy/ipk</command>).</para> <para>Now, every image built will automatically contain feed configs for the deploy directory (as of time of writing, deploy directory is internally structured with - per-arch subdirectories; so, there several feed configs are being generated, one for each subdirectory). + per-arch subdirectories; so, there are several feed configs being generated, one for each subdirectory). </para> </section> </section> -</section>
\ No newline at end of file +</section> diff --git a/docs/usermanual/reference/class_siteinfo.xml b/docs/usermanual/reference/class_siteinfo.xml index 82dbd84f6e..ca42b61480 100644 --- a/docs/usermanual/reference/class_siteinfo.xml +++ b/docs/usermanual/reference/class_siteinfo.xml @@ -23,7 +23,7 @@ <variablelist> <varlistentry> - <term>SITEINFO_ENDIANESS</term> + <term>SITEINFO_ENDIANNESS</term> <listitem> <para>Defines the endianess of the target as either @@ -55,19 +55,19 @@ </varlistentry> </variablelist> - <para>A typical use for the <command>SITEINFO_ENDIANESS</command> and + <para>A typical use for the <command>SITEINFO_ENDIANNESS</command> and <command>SITEINFO_BITS</command> variables is to provide configuration within a recipe based on their values. The following example from the <emphasis>openssl</emphasis> recipe showw the correct define for the endiness of the target being passed to openssl via the compiler flags. The define to add to the flags is set based on the value of the - <command>SITEINFO_ENDIANESS</command> variable. Note that use of the + <command>SITEINFO_ENDIANNESS</command> variable. Note that use of the <emphasis>base_conditional</emphasis> method (see the <xref linkend="recipes_advanced_python" /> section) to select a value conditional on the endianess setting:</para> <para><screen> # Additional flag based on target endiness (see siteinfo.bbclass) - CFLAG="${CFLAG} ${@base_conditional('SITEINFO_ENDIANESS', 'le', '-DL_ENDIAN', '-DB_ENDIAN', d)}"</screen></para> + CFLAG="${CFLAG} ${@base_conditional('SITEINFO_ENDIANNESS', 'le', '-DL_ENDIAN', '-DB_ENDIAN', d)}"</screen></para> <section> <title>CONFIG_SITE: The autoconf site files</title> diff --git a/docs/usermanual/reference/dirs_install.xml b/docs/usermanual/reference/dirs_install.xml index 75f85ac930..14f3fc645e 100644 --- a/docs/usermanual/reference/dirs_install.xml +++ b/docs/usermanual/reference/dirs_install.xml @@ -6,7 +6,7 @@ control the directories into which files are installed.</para> <para>These variables can be used directly by the recipe to refer to paths - that will be used after the package is installed. For example, when specify + that will be used after the package is installed. For example, when specifying the location of configuration files you need to specify the location on the target as show in the following example from quagga:<screen># Indicate that the default files are configuration files CONFFILES_${PN} = "${sysconfdir}/default/quagga" diff --git a/docs/usermanual/reference/fakeroot.xml b/docs/usermanual/reference/fakeroot.xml index 5eb6a48eb0..845756551b 100644 --- a/docs/usermanual/reference/fakeroot.xml +++ b/docs/usermanual/reference/fakeroot.xml @@ -45,7 +45,7 @@ brw------- 1 root root 22, 0 Aug 18 13:20 hdc device node, even though we did not have to give a password for the root user. In reality this device node still doesn't exist, it just looks like it exits. Fakeroot is lying to the shell process and telling it that - <emphasis>"yes, this file exists and these are it's + <emphasis>"yes, this file exists and these are its properties"</emphasis>. We'll talk more about how fakeroot actually works in a minute.</para> @@ -183,4 +183,4 @@ crw-r----- root/root 204,10 2006-08-16 13:07:12 ./dev/ttySC2 oe_runmake install-man DESTDIR=${D} ...</screen></para> </section> -</section>
\ No newline at end of file +</section> diff --git a/docs/usermanual/reference/var_src_uri.xml b/docs/usermanual/reference/var_src_uri.xml index b858e8abb0..95632569dd 100644 --- a/docs/usermanual/reference/var_src_uri.xml +++ b/docs/usermanual/reference/var_src_uri.xml @@ -2,7 +2,7 @@ <section id="src_uri_variable" xreflabel="SRC_URI variable"> <title>SRC_URI variable: Source code and patches</title> - <para>All recipies need to contain a definition of + <para>All recipes need to contain a definition of <command>SRC_URI</command>. It determines what files and source code is needed and where that source code should be obtained from. This includes patches to be applied and basic files that are shipped as part of the @@ -10,8 +10,8 @@ <para>A typical <command>SRC_URI</command> contains a list of URL's, patches and files as shown in this example from quagga:<screen>SRC_URI = "http://www.quagga.net/download/quagga-${PV}.tar.gz \ - file://ospfd-no-opaque-lsa-fix.patch;patch=1 \ - file://fix-for-lib-inpath.patch;patch=1 \ + file://ospfd-no-opaque-lsa-fix.patch \ + file://fix-for-lib-inpath.patch \ file://quagga.init \ file://quagga.default \ file://watchquagga.init \ @@ -37,13 +37,13 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 a checksum will throw errors.</para> <para>Each URI supports a set of additional options. These options are tag/value pairs of the form <command>"a=b"</command> and are semi-colon - separated from each other and from the URI. The follow examples shows two - options being included, the patch and pnum options:<screen>file://ospfd-no-opaque-lsa-fix.patch;patch=1;pnum=2</screen>The + separated from each other and from the URI. The following example shows one + option being included, the striplevel option:<screen>file://ospfd-no-opaque-lsa-fix.patch;striplevel=2</screen>The supported methods for fetching source and files are:</para> <variablelist> <varlistentry> - <term>http, https, ftps</term> + <term>http, https, ftp, ftps</term> <listitem> <para>Used to download files and source code via the specified URL. @@ -113,7 +113,7 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 </varlistentry> <varlistentry> - <term>.tbz, .tar.bz2</term> + <term>.tbz, .tbz2, .tar.bz2</term> <listitem> <para>Bzip2 compressed tar archives which will be extracted with @@ -143,7 +143,25 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 </varlistentry> <varlistentry> - <term>.zip</term> + <term>.xz</term> + + <listitem> + <para>xz (LZMA2) compressed files which will be decompressed with + <command>"xz -dc <srcfile> > <srcfile>"</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>.tar.xz</term> + + <listitem> + <para>xz (LZMA2) compressed tar archives which will be decompressed with + <command>"xz -dc <srcfile> | tar x --no-same-owner -f -"</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>.zip, .jar</term> <listitem> <para>Zip archives which will be extracted with <command>"unzip -q @@ -209,7 +227,7 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 scripts, to be included in the final package.</para> <para>The following example shows the specification of a patch - file:<screen>file://ospfd-no-opaque-lsa-fix.patch;patch=1</screen></para> + file:<screen>file://ospfd-no-opaque-lsa-fix.patch</screen></para> <para>Patch files are be copied to the patches subdirectory of the source directory, <command>${S}/patches</command>, and then applied from the @@ -234,18 +252,21 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 <variablelist> <varlistentry> - <term>patch</term> + <term>apply={yes|no}</term> <listitem> - <para>Used as <command>"patch=1"</command> to define this file as a - patch file. Patch files will be copied to + <para>If set to 'yes' it is used as <command>"patch=1"</command> to define this file as a + patch file. Patch files will be symlinked into <command>${S}/patches</command> and then applied to source from - within the source directory, <command>${S}</command>.</para> + within the source directory, <command>${S}</command>. + If set to 'no' the file will be copied to <command>${S}</command> + during unpack. + </para> </listitem> </varlistentry> <varlistentry> - <term>pnum</term> + <term>striplevel</term> <listitem> <para>By default patches are applied with the <command>"-p @@ -254,7 +275,7 @@ SRC_URI[sha256sum] = "36bdb85c97b39ac604bc58cb7857ee08295242c78a12848ef8a31 the value passed to <command>"-p"</command>. The most typical use is when the patches are relative to the source directory already and need to be applied using <command>"-p 0"</command>, in which case - the <command>"pnum=0"</command> option is supplied.</para> + the <command>"striplevel=0"</command> option is supplied.</para> </listitem> </varlistentry> </variablelist> |