diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-22 12:35:13 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:19 +0000 |
commit | 8275b929ec31744f3de1088c4bb1ed20aa9daa93 (patch) | |
tree | a9c6a95cf3c52e10ec1539ea4c56b44311c4b7bc | |
parent | 47e7abc5190ccbcef1ae6c7cb46f563d30b32f32 (diff) | |
download | poky-8275b929ec31744f3de1088c4bb1ed20aa9daa93.tar.gz |
ref-manual: Updates and additions to variable glossary:
I applied some review edits to the USERADD_PACKAGES and
USERADD_PARAM variables from Paul. Additionally, I added descriptions
for the GROUPADD_PARAM and GROUPMEMS_PARAM variables.
(From yocto-docs rev: 0c52a79efb2cf7c708ea989ab307be04f27484dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 108 |
1 files changed, 104 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index d592fbe3df..fb337913ca 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -22,7 +22,7 @@ | |||
22 | <link linkend='var-D'>D</link> | 22 | <link linkend='var-D'>D</link> |
23 | <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link> | 23 | <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link> |
24 | <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link> | 24 | <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link> |
25 | <!-- <link linkend='var-glossary-g'>G</link> --> | 25 | <link linkend='var-GROUPADD_PARAM'>G</link> |
26 | <link linkend='var-HOMEPAGE'>H</link> | 26 | <link linkend='var-HOMEPAGE'>H</link> |
27 | <link linkend='var-IMAGE_BASENAME'>I</link> | 27 | <link linkend='var-IMAGE_BASENAME'>I</link> |
28 | <!-- <link linkend='var-glossary-j'>J</link> --> | 28 | <!-- <link linkend='var-glossary-j'>J</link> --> |
@@ -2029,11 +2029,54 @@ | |||
2029 | </para> | 2029 | </para> |
2030 | </glossdef> | 2030 | </glossdef> |
2031 | </glossentry> | 2031 | </glossentry> |
2032 | |||
2033 | </glossdiv> | 2032 | </glossdiv> |
2034 | 2033 | ||
2035 | <!-- <glossdiv id='var-glossary-g'><title>G</title>--> | 2034 | <glossdiv id='var-glossary-g'><title>G</title> |
2036 | <!-- </glossdiv>--> | 2035 | |
2036 | <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm> | ||
2037 | <glossdef> | ||
2038 | <para> | ||
2039 | When a recipe inherits the | ||
2040 | <filename>useradd</filename> class, this variable | ||
2041 | specifies for a package what parameters should be passed | ||
2042 | to the <filename>groupadd</filename> command | ||
2043 | if you wish to add a group to the system when the package | ||
2044 | is installed. | ||
2045 | </para> | ||
2046 | |||
2047 | <para> | ||
2048 | Here is an example from the <filename>dbus</filename> | ||
2049 | recipe: | ||
2050 | <literallayout class='monospaced'> | ||
2051 | GROUPADD_PARAM_${PN} = "-r netdev" | ||
2052 | </literallayout> | ||
2053 | For information on the standard Linux shell command | ||
2054 | <filename>groupadd</filename>, see | ||
2055 | <ulink url='http://linux.die.net/man/8/groupadd'></ulink>. | ||
2056 | </para> | ||
2057 | </glossdef> | ||
2058 | </glossentry> | ||
2059 | |||
2060 | <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm> | ||
2061 | <glossdef> | ||
2062 | <para> | ||
2063 | When a recipe inherits the | ||
2064 | <filename>useradd</filename> class, this variable | ||
2065 | specifies for a package what parameters should be passed | ||
2066 | to the <filename>groupmems</filename> command | ||
2067 | if you wish to modify the members of a group when the | ||
2068 | package is installed. | ||
2069 | </para> | ||
2070 | |||
2071 | <para> | ||
2072 | For information on the standard Linux shell command | ||
2073 | <filename>groupmems</filename>, see | ||
2074 | <ulink url='http://linux.die.net/man/8/groupmems'></ulink>. | ||
2075 | </para> | ||
2076 | </glossdef> | ||
2077 | </glossentry> | ||
2078 | |||
2079 | </glossdiv> | ||
2037 | 2080 | ||
2038 | <glossdiv id='var-glossary-h'><title>H</title> | 2081 | <glossdiv id='var-glossary-h'><title>H</title> |
2039 | 2082 | ||
@@ -6047,6 +6090,63 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6047 | </glossdef> | 6090 | </glossdef> |
6048 | </glossentry> | 6091 | </glossentry> |
6049 | 6092 | ||
6093 | <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> | ||
6094 | <glossdef> | ||
6095 | <para> | ||
6096 | When a recipe inherits the | ||
6097 | <filename>useradd</filename> class, this variable | ||
6098 | specifies the individual packages within the recipe that | ||
6099 | require users and/or groups to be added. | ||
6100 | </para> | ||
6101 | |||
6102 | <para> | ||
6103 | You must set this variable if the recipe inherits the | ||
6104 | class. | ||
6105 | For example, the following enables adding a user for the | ||
6106 | main package in a recipe: | ||
6107 | <literallayout class='monospaced'> | ||
6108 | USERADD_PACKAGES = "${PN}" | ||
6109 | </literallayout> | ||
6110 | <note> | ||
6111 | If follows that if you are going to use the | ||
6112 | <filename>USERADD_PACKAGES</filename> variable, | ||
6113 | you need to set one or more of the | ||
6114 | <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>, | ||
6115 | <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>, | ||
6116 | or | ||
6117 | <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link> | ||
6118 | variables. | ||
6119 | </note> | ||
6120 | </para> | ||
6121 | |||
6122 | </glossdef> | ||
6123 | </glossentry> | ||
6124 | |||
6125 | <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> | ||
6126 | <glossdef> | ||
6127 | <para> | ||
6128 | When a recipe inherits the | ||
6129 | <filename>useradd</filename> class, this variable | ||
6130 | specifies for a package what parameters should be passed | ||
6131 | to the <filename>useradd</filename> command | ||
6132 | if you wish to add a user to the system when the package | ||
6133 | is installed. | ||
6134 | </para> | ||
6135 | |||
6136 | <para> | ||
6137 | Here is an example from the <filename>dbus</filename> | ||
6138 | recipe: | ||
6139 | <literallayout class='monospaced'> | ||
6140 | USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ | ||
6141 | --no-create-home --shell /bin/false \ | ||
6142 | --user-group messagebus" | ||
6143 | </literallayout> | ||
6144 | For information on the standard Linux shell command | ||
6145 | <filename>useradd</filename>, see | ||
6146 | <ulink url='http://linux.die.net/man/8/useradd'></ulink>. | ||
6147 | </para> | ||
6148 | </glossdef> | ||
6149 | </glossentry> | ||
6050 | </glossdiv> | 6150 | </glossdiv> |
6051 | 6151 | ||
6052 | <!-- <glossdiv id='var-glossary-v'><title>V</title>--> | 6152 | <!-- <glossdiv id='var-glossary-v'><title>V</title>--> |