From 8eb706a41b040cf1397c2ebe5517c40031f4d1fb Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 14 Oct 2014 06:57:45 -0700 Subject: ref-manual, dev-manual: Applied migration review edits. Applied the full set of first draft revision edits for the new migration section for 1.7. Comments from Paul Eggleton. (From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 44 +++++++++----- documentation/ref-manual/migration.xml | 85 ++++++++++++--------------- documentation/ref-manual/ref-classes.xml | 22 +++---- documentation/ref-manual/ref-variables.xml | 83 ++++++++------------------ documentation/ref-manual/usingpoky.xml | 2 +- 5 files changed, 103 insertions(+), 133 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 12ad46bbdf..55bad34064 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -279,20 +279,36 @@ Within this group, you will find several kernels supported by the Yocto Project: - linux-yocto-3.8 - The - stable Yocto Project kernel to use with the Yocto Project Release 1.4. This kernel - is based on the Linux 3.8 released kernel. - linux-yocto-3.10 - The - stable Yocto Project kernel to use with the Yocto Project Release 1.5. This kernel - is based on the Linux 3.10 released kernel. - linux-yocto-3.14 - The - stable Yocto Project kernel to use with the Yocto Project Release 1.6. This kernel - is based on the Linux 3.14 released kernel. - linux-yocto-3.17 - The - stable Yocto Project kernel to use with the Yocto Project Release 1.7. This kernel - is based on the Linux 3.17 released kernel. - linux-yocto-dev - A development - kernel based on the latest upstream release candidate available. + + linux-yocto-3.8 - The + stable Yocto Project kernel to use with the Yocto + Project Release 1.4. This kernel is based on the + Linux 3.8 released kernel. + + + linux-yocto-3.10 - The + stable Yocto Project kernel to use with the Yocto + Project Release 1.5. + This kernel is based on the Linux 3.10 released kernel. + + + linux-yocto-3.14 - The + stable Yocto Project kernel to use with the Yocto + Project Releases 1.6 and 1.7. + These kernels are based on the Linux 3.14 and 3.17 + released kernels, respectively. + + + linux-yocto-3.17 - An + additional Yocto Project kernel used with the Yocto + Project Release 1.7. + This kernel is based on the Linux 3.17 released kernel. + + + linux-yocto-dev - A + development kernel based on the latest upstream release + candidate available. + diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 864c489251..dd8c3e00cc 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -1710,17 +1710,19 @@ class changes occurred: - A separate build directory in Autotools recipes is - handled: + A separate build directory is now used by default: The autotools class has been changed to use a directory for building (B), which is separate from the source directory (S). - If the software being built is already capable of + This is commonly referred to as + B != S, or an out-of-tree build. + If the software being built is already capable of building in a directory separate from the source, you do not need to do anything. - However, if this capability does not exist, you will + However, if the software is not capable of being built + in this manner, you will need to either patch the software so that it can build separately, or you will need to change the recipe to inherit the @@ -1728,25 +1730,24 @@ class instead of the autotools class. - Handle "foreign": - The --foreign option is no longer - passed to automake when running - autoreconf. + The ‐‐foreign option is + no longer passed to automake when + running autoconf: This option tells automake that a particular software package does not follow the GNU standards and therefore should not be expected to distribute certain files such as ChangeLog, AUTHORS, and so forth. - The majority of upstream software packages already tell - automake these packages are foreign - and thus this option is mostly superfluous. + Because the majority of upstream software packages already + tell automake to enable foreign mode + themselves, the option is mostly superfluous. However, some recipes will need patches for this change. You can easily make the change by patching configure.ac so that it passes "foreign" to AM_INIT_AUTOMAKE(). See - + this commit for an example showing how to make the patch. @@ -1757,12 +1758,12 @@ Binary Configuration Scripts Disabled - Some of the core recipes that previously packaged binary - configuration scripts now disable the scripts instead due to the + Some of the core recipes that package binary configuration scripts + now disable the scripts instead due to the scripts previously requiring error-prone path substitution. Software that links against these libraries using these scripts - should use the much more robust - pkg-config instead. + should use the much more robust pkg-config + instead. The list of recipes changed in this version (and their configuration scripts) is as follows: @@ -1787,12 +1788,10 @@ pth (pth-config) taglib (taglib-config) - - Support for pkg-config has been added to - some recipes in the previous list in the rare cases - where the upstream software package does not already provide - it. - + Additionally, support for pkg-config has been + added to some recipes in the previous list in the rare cases + where the upstream software package does not already provide + it. @@ -1811,15 +1810,15 @@ - glibc 2.20 also minimally requires version - 2.6.32 of the Linux kernel. + glibc 2.20 requires version 2.6.32 or greater + of the Linux kernel. Thus, older kernels will no longer be usable in conjunction with it. For full details on the changes in glibc 2.20, - see the upstream release notes at - . + see the upstream release notes + here. @@ -1829,33 +1828,25 @@ The module_autoload_* - and - module_conf_* - variables have been replaced with the variables + variable is now deprecated and a new KERNEL_MODULE_AUTOLOAD - and - KERNEL_MODULE_PROBECONF, - respectively. - These variables no longer require you to specify the module name + variable should be used instead. + Also, + module_conf_* + must now be used in conjunction with a new + KERNEL_MODULE_PROBECONF + variable. + The new variables no longer require you to specify the module name as part of the variable name. This change not only simplifies usage but also allows the values of these variables to be appropriately incorporated into task signatures and thus trigger the appropriate tasks to re-execute when changed. You should replace any references to - module_autoload_* or - module_conf_* with the new variables. - - While it is recommended that you replace occurrences of the - module_conf_* variable with the - KERNEL_MODULE_PROBECONF variable, the - OpenEmbedded build system still recognizes the - module_conf_* variable. - However, you must be sure that any module name used in the - override with the module_conf variable - is included in the KERNEL_MODULE_PROBECONF - variable. - + module_autoload_* with + KERNEL_MODULE_AUTOLOAD, and add any modules + for which module_conf_* is specified to + KERNEL_MODULE_PROBECONF. @@ -1863,7 +1854,7 @@ KERNEL_MODULE_AUTOLOAD and KERNEL_MODULE_PROBECONF - descriptions in the variable's glossary. + variables. diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 3e7662e146..1b01ef61c9 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -101,6 +101,17 @@ section in the Yocto Project Development Manual. + + By default, the autotools class supports + out-of-tree builds + (B != + S). + If your recipes do not support out-of-tree builds, you should + have them inherit the + autotools-brokensep + class. + + It's useful to have some idea of how the tasks defined by this class work and what they do behind the scenes. @@ -123,17 +134,6 @@ - - - It is planned for future Yocto Project releases that by default, the - autotools class supports out-of-tree builds - (B != - S). - If your recipes do not support out-of-tree builds, you should - have them inherit the - autotools-brokensep - class. -
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 1cff5bdfaa..aadae01ac4 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -4458,7 +4458,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Specify it as follows: - KERNEL_MODULE_AUTOLOAD = "modname1 modname2 modname3" + KERNEL_MODULE_AUTOLOAD += "modname1 modname2 modname3" @@ -4470,7 +4470,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The modules appear one-per-line in the file. Here is an example of the most common use case: - KERNEL_MODULE_AUTOLOAD = "modname" + KERNEL_MODULE_AUTOLOAD += "modname" @@ -4487,58 +4487,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" KERNEL_MODULE_PROBECONF - Specifies - modprobe.d - syntax lines for inclusion in the - /etc/modprobe.d/modname.conf file. - - The KERNEL_MODULE_PROBECONF - variable behaves the same as the - module_conf - variable with the exception of not having to use a - module name override. - - - - - You can use the - KERNEL_MODULE_PROBECONF variable - anywhere it can be recognized by the kernel recipe or - an out-of-tree kernel module recipe (e.g. a machine - configuration file, a distribution configuration file, an - append file for the recipe, or the recipe itself). - - - - Here is the general syntax: - - KERNEL_MODULE_PROBECONF = "<modprobe.d syntax>" - - - - - Run man modprobe.d in the shell to - find out more information on the exact syntax - you want to provide with KERNEL_MODULE_PROBECONF. - - - - Including KERNEL_MODULE_PROBECONF causes - the OpenEmbedded build system to populate the - /etc/modprobe.d/modname.conf - file with modprobe.d syntax lines. - Here is an example that adds the options - arg1 and arg2 - to a module named mymodule: - - KERNEL_MODULE_PROBECONF = "options mymodule arg1=val1 arg2=val2" - - - - - For information on how to specify kernel modules to - auto-load on boot, see the - KERNEL_MODULE_AUTOLOAD variable. + Provides a list of modules for which the OpenEmbedded + build system expects to find + module_conf_<modname> + values that specify configuration for each of the modules. + For information on how to provide those module + configurations, see the + module_conf_* + variable. @@ -5410,12 +5366,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. - You should replace all occurrences of the - module_autoload variable with - KERNEL_MODULE_AUTOLOAD variables. + You should replace all occurrences of + module_autoload with additions to + KERNEL_MODULE_AUTOLOAD, for example: + + module_autoload_rfcomm = "rfcomm" + + should now be replaced with: + + KERNEL_MODULE_AUTOLOAD += "rfcomm" + See the KERNEL_MODULE_AUTOLOAD - variable for a description of the variable. + variable for more information. @@ -5437,7 +5400,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" recipe, or the recipe itself). If you use this variable, you must also be sure to list the module name in the - KERNEL_MODULE_PROBECONF + KERNEL_MODULE_AUTOLOAD variable. @@ -5471,7 +5434,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" For information on how to specify kernel modules to auto-load on boot, see the - module_autoload + KERNEL_MODULE_AUTOLOAD variable. diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 5a6a4068a7..283fb725ac 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -540,7 +540,7 @@ Build history information is kept in - $TOPDIR/buildhistory + ${TOPDIR}/buildhistory in the Build Directory as defined by the BUILDHISTORY_DIR variable. -- cgit v1.2.3-54-g00ecf