summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-23 07:05:25 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-23 15:20:20 +0100
commit78c5c175ae173fc30db39f5e78aaf55b490f3e2a (patch)
treed442b0393345be98bd393a1420bb02bfe0ec139e /documentation/ref-manual
parent38c853a83df6bfc721b563044a72f78466fa1f81 (diff)
downloadpoky-78c5c175ae173fc30db39f5e78aaf55b490f3e2a.tar.gz
ref-manual: Cleaned up wording in glossary for "inheriting"
For consistency, I changed the introductory sentence to the variables that function when inherited. (From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml102
1 files changed, 58 insertions, 44 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 09d01cb478..b69bea6e58 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -934,8 +934,9 @@
934 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> 934 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
935 <glossdef> 935 <glossdef>
936 <para> 936 <para>
937 When inheriting <filename>binconfig.bbclass</filename> 937 When inheriting the
938 from a recipe, this variable specifies a wildcard for 938 <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
939 class, this variable specifies a wildcard for
939 configuration scripts that need editing. 940 configuration scripts that need editing.
940 The scripts are edited to correct any paths that have been 941 The scripts are edited to correct any paths that have been
941 set up during compilation so that they are correct for 942 set up during compilation so that they are correct for
@@ -1085,8 +1086,8 @@
1085 <para> 1086 <para>
1086 When inheriting the 1087 When inheriting the
1087 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1088 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1088 class, specifies whether or not to commit the build 1089 class, this variable specifies whether or not to commit the
1089 history output in a local Git repository. 1090 build history output in a local Git repository.
1090 If set to "1", this local repository will be maintained 1091 If set to "1", this local repository will be maintained
1091 automatically by the 1092 automatically by the
1092 <filename>buildhistory</filename> 1093 <filename>buildhistory</filename>
@@ -1113,7 +1114,8 @@
1113 <para> 1114 <para>
1114 When inheriting the 1115 When inheriting the
1115 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1116 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1116 class, specifies the author to use for each Git commit. 1117 class, this variable specifies the author to use for each
1118 Git commit.
1117 In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> 1119 In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename>
1118 variable to work, the 1120 variable to work, the
1119 <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> 1121 <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
@@ -1143,8 +1145,8 @@
1143 <para> 1145 <para>
1144 When inheriting the 1146 When inheriting the
1145 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1147 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1146 class, specifies the directory in which build history 1148 class, this variable specifies the directory in which
1147 information is kept. 1149 build history information is kept.
1148 For more information on how the variable works, see the 1150 For more information on how the variable works, see the
1149 <filename>buildhistory.class</filename>. 1151 <filename>buildhistory.class</filename>.
1150 </para> 1152 </para>
@@ -1164,7 +1166,8 @@
1164 <para> 1166 <para>
1165 When inheriting the 1167 When inheriting the
1166 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1168 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1167 class, specifies the build history features to be enabled. 1169 class, this variable specifies the build history features
1170 to be enabled.
1168 For more information on how build history works, see the 1171 For more information on how build history works, see the
1169 "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" 1172 "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
1170 section. 1173 section.
@@ -1204,7 +1207,8 @@
1204 <para> 1207 <para>
1205 When inheriting the 1208 When inheriting the
1206 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1209 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1207 class, specifies a list of paths to files copied from the 1210 class, this variable specifies a list of paths to files
1211 copied from the
1208 image contents into the build history directory under 1212 image contents into the build history directory under
1209 an "image-files" directory in the directory for 1213 an "image-files" directory in the directory for
1210 the image, so that you can track the contents of each file. 1214 the image, so that you can track the contents of each file.
@@ -1232,8 +1236,8 @@
1232 <para> 1236 <para>
1233 When inheriting the 1237 When inheriting the
1234 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> 1238 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
1235 class, optionally specifies a remote repository 1239 class, this variable optionally specifies a remote
1236 to which build history pushes Git changes. 1240 repository to which build history pushes Git changes.
1237 In order for <filename>BUILDHISTORY_PUSH_REPO</filename> 1241 In order for <filename>BUILDHISTORY_PUSH_REPO</filename>
1238 to work, 1242 to work,
1239 <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> 1243 <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
@@ -1598,8 +1602,9 @@
1598 <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm> 1602 <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm>
1599 <glossdef> 1603 <glossdef>
1600 <para> 1604 <para>
1601 When a recipe inherits the 1605 When inheriting the
1602 <filename>distro_features_check</filename> class, this 1606 <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
1607 class, this
1603 variable identifies distribution features that would 1608 variable identifies distribution features that would
1604 be in conflict should the recipe 1609 be in conflict should the recipe
1605 be built. 1610 be built.
@@ -1929,7 +1934,7 @@
1929 <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm> 1934 <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm>
1930 <glossdef> 1935 <glossdef>
1931 <para> 1936 <para>
1932 For recipes that inherit the 1937 When inheriting the
1933 <link linkend='ref-classes-deploy'><filename>deploy</filename></link> 1938 <link linkend='ref-classes-deploy'><filename>deploy</filename></link>
1934 class, the <filename>DEPLOYDIR</filename> points to a 1939 class, the <filename>DEPLOYDIR</filename> points to a
1935 temporary work area for deployed files that is set in the 1940 temporary work area for deployed files that is set in the
@@ -2240,10 +2245,11 @@
2240 <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm> 2245 <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
2241 <glossdef> 2246 <glossdef>
2242 <para> 2247 <para>
2243 When inheriting <filename>compress_doc.bbclass</filename> 2248 When inheriting the
2244 from a recipe, this variable sets the compression policy 2249 <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link>
2245 used when the OpenEmbedded build system compresses man 2250 class, this variable sets the compression policy used when
2246 pages and info pages. 2251 the OpenEmbedded build system compresses man pages and info
2252 pages.
2247 By default, the compression method used is gz (gzip). 2253 By default, the compression method used is gz (gzip).
2248 Other policies available are xz and bz2. 2254 Other policies available are xz and bz2.
2249 </para> 2255 </para>
@@ -2398,8 +2404,9 @@
2398 <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> 2404 <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
2399 <glossdef> 2405 <glossdef>
2400 <para> 2406 <para>
2401 If <filename>externalsrc.bbclass</filename> is inherited, 2407 When inheriting the
2402 this variable points to the source tree, which is 2408 <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
2409 class, this variable points to the source tree, which is
2403 outside of the OpenEmbedded build system. 2410 outside of the OpenEmbedded build system.
2404 When set, this variable sets the 2411 When set, this variable sets the
2405 <link linkend='var-S'><filename>S</filename></link> 2412 <link linkend='var-S'><filename>S</filename></link>
@@ -2423,10 +2430,11 @@
2423 <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm> 2430 <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
2424 <glossdef> 2431 <glossdef>
2425 <para> 2432 <para>
2426 If <filename>externalsrc.bbclass</filename> is inherited, 2433 When inheriting the
2427 this variable points to the directory in which the recipe's 2434 <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
2428 source code is built, 2435 class, this variable points to the directory in which the
2429 which is outside of the OpenEmbedded build system. 2436 recipe's source code is built, which is outside of the
2437 OpenEmbedded build system.
2430 When set, this variable sets the 2438 When set, this variable sets the
2431 <link linkend='var-B'><filename>B</filename></link> 2439 <link linkend='var-B'><filename>B</filename></link>
2432 variable, which is what the OpenEmbedded build system uses 2440 variable, which is what the OpenEmbedded build system uses
@@ -2575,7 +2583,7 @@
2575 <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm> 2583 <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm>
2576 <glossdef> 2584 <glossdef>
2577 <para> 2585 <para>
2578 When a recipe inherits the 2586 When inheriting the
2579 <link linkend='ref-classes-scons'><filename>scons</filename></link> 2587 <link linkend='ref-classes-scons'><filename>scons</filename></link>
2580 class, this variable specifies additional configuration 2588 class, this variable specifies additional configuration
2581 options you want to pass to the 2589 options you want to pass to the
@@ -2623,7 +2631,7 @@
2623 <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm> 2631 <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm>
2624 <glossdef> 2632 <glossdef>
2625 <para> 2633 <para>
2626 When a recipe inherits the 2634 When inheriting the
2627 <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link> 2635 <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link>
2628 class, this variable provides image level user and group 2636 class, this variable provides image level user and group
2629 operations. 2637 operations.
@@ -2933,7 +2941,7 @@
2933 <glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm> 2941 <glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm>
2934 <glossdef> 2942 <glossdef>
2935 <para> 2943 <para>
2936 When a recipe inherits the 2944 When inheriting the
2937 <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> 2945 <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link>
2938 class, this variable identifies packages containing font 2946 class, this variable identifies packages containing font
2939 files that need to be cached by Fontconfig. 2947 files that need to be cached by Fontconfig.
@@ -2987,8 +2995,9 @@
2987 <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm> 2995 <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm>
2988 <glossdef> 2996 <glossdef>
2989 <para> 2997 <para>
2990 When a recipe inherits the 2998 When inheriting the
2991 <filename>useradd</filename> class, this variable 2999 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
3000 class, this variable
2992 specifies for a package what parameters should be passed 3001 specifies for a package what parameters should be passed
2993 to the <filename>groupadd</filename> command 3002 to the <filename>groupadd</filename> command
2994 if you wish to add a group to the system when the package 3003 if you wish to add a group to the system when the package
@@ -3011,8 +3020,9 @@
3011 <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm> 3020 <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm>
3012 <glossdef> 3021 <glossdef>
3013 <para> 3022 <para>
3014 When a recipe inherits the 3023 When inheriting the
3015 <filename>useradd</filename> class, this variable 3024 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
3025 class, this variable
3016 specifies for a package what parameters should be passed 3026 specifies for a package what parameters should be passed
3017 to the <filename>groupmems</filename> command 3027 to the <filename>groupmems</filename> command
3018 if you wish to modify the members of a group when the 3028 if you wish to modify the members of a group when the
@@ -3084,7 +3094,7 @@
3084 <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm> 3094 <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm>
3085 <glossdef> 3095 <glossdef>
3086 <para> 3096 <para>
3087 For recipes that inherit the 3097 When inheriting the
3088 <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link> 3098 <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link>
3089 class, this variable specifies the packages that contain the 3099 class, this variable specifies the packages that contain the
3090 GTK+ input method modules being installed when the modules 3100 GTK+ input method modules being installed when the modules
@@ -5762,8 +5772,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5762 <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm> 5772 <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm>
5763 <glossdef> 5773 <glossdef>
5764 <para> 5774 <para>
5765 When a recipe inherits the 5775 When inheriting the
5766 <filename>binconfig.bbclass</filename> class, this variable 5776 <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
5777 class, this variable
5767 specifies additional arguments passed to the "sed" command. 5778 specifies additional arguments passed to the "sed" command.
5768 The sed command alters any paths in configuration scripts 5779 The sed command alters any paths in configuration scripts
5769 that have been set up during compilation. 5780 that have been set up during compilation.
@@ -6477,7 +6488,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6477 <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm> 6488 <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm>
6478 <glossdef> 6489 <glossdef>
6479 <para> 6490 <para>
6480 When a recipe inherits the 6491 When inheriting the
6481 <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link> 6492 <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link>
6482 class, this variable identifies packages that contain 6493 class, this variable identifies packages that contain
6483 the pixbuf loaders used with 6494 the pixbuf loaders used with
@@ -7193,8 +7204,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7193 <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm> 7204 <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm>
7194 <glossdef> 7205 <glossdef>
7195 <para> 7206 <para>
7196 When a recipe inherits the 7207 When inheriting the
7197 <filename>distro_features_check</filename> class, this 7208 <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
7209 class, this
7198 variable identifies distribution features that must 7210 variable identifies distribution features that must
7199 exist in the current configuration in order for the 7211 exist in the current configuration in order for the
7200 OpenEmbedded build system to build the recipe. 7212 OpenEmbedded build system to build the recipe.
@@ -8645,7 +8657,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8645 <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm> 8657 <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm>
8646 <glossdef> 8658 <glossdef>
8647 <para> 8659 <para>
8648 For recipes that inherit the 8660 When inheriting the
8649 <link linkend='ref-classes-systemd'><filename>systemd</filename></link> 8661 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
8650 class, this variable specifies whether the service you have 8662 class, this variable specifies whether the service you have
8651 specified in 8663 specified in
@@ -8668,7 +8680,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8668 <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm> 8680 <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
8669 <glossdef> 8681 <glossdef>
8670 <para> 8682 <para>
8671 For recipes that inherit the 8683 When inheriting the
8672 <link linkend='ref-classes-systemd'><filename>systemd</filename></link> 8684 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
8673 class, this variable locates the systemd unit files when 8685 class, this variable locates the systemd unit files when
8674 they are not found in the main recipe's package. 8686 they are not found in the main recipe's package.
@@ -8691,7 +8703,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8691 <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm> 8703 <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm>
8692 <glossdef> 8704 <glossdef>
8693 <para> 8705 <para>
8694 For recipes that inherit the 8706 When inheriting the
8695 <link linkend='ref-classes-systemd'><filename>systemd</filename></link> 8707 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
8696 class, this variable specifies the systemd service name for 8708 class, this variable specifies the systemd service name for
8697 a package. 8709 a package.
@@ -10012,8 +10024,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10012 <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> 10024 <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm>
10013 <glossdef> 10025 <glossdef>
10014 <para> 10026 <para>
10015 When a recipe inherits the 10027 When inheriting the
10016 <filename>useradd</filename> class, this variable 10028 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
10029 class, this variable
10017 specifies the individual packages within the recipe that 10030 specifies the individual packages within the recipe that
10018 require users and/or groups to be added. 10031 require users and/or groups to be added.
10019 </para> 10032 </para>
@@ -10044,8 +10057,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10044 <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> 10057 <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm>
10045 <glossdef> 10058 <glossdef>
10046 <para> 10059 <para>
10047 When a recipe inherits the 10060 When inheriting the
10048 <filename>useradd</filename> class, this variable 10061 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
10062 class, this variable
10049 specifies for a package what parameters should be passed 10063 specifies for a package what parameters should be passed
10050 to the <filename>useradd</filename> command 10064 to the <filename>useradd</filename> command
10051 if you wish to add a user to the system when the package 10065 if you wish to add a user to the system when the package