ref-manual: Added extrausers class and EXTRA_USERS_PARAMS variable.

(From yocto-docs rev: e339505941f620ff74cd1bdd5f652c341baf2aad)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-11-27 09:13:30 -08:00 committed by Richard Purdie
parent affd9bf773
commit 6032dcdb32
2 changed files with 72 additions and 0 deletions

View File

@ -535,6 +535,44 @@
</para>
</section>
<section id='ref-classes-extrausers'>
<title><filename>extrausers.bbclass</filename></title>
<para>
The extra users (<filename>extrausers</filename>) class allows
additional user and group configuration to be applied at the image
level.
Inheriting this class either globally or from an image recipe allows
additional user and group operations to be performed using the
<link linkend='var-EXTRA_USERS_PARAMS'><filename>EXTRA_USERS_PARAMS</filename></link>
variable.
<note>
The user and group operations added using the
<filename>extrausers</filename> class are not tied to a specific
recipe but can be performed across the image as a whole.
See the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class for information on how to add user and group configuration
to a specific recipe.
</note>
</para>
<para>
Here is an example that uses this class in an image recipe:
<literallayout class='monospaced'>
inherit extrausers
EXTRA_USERS_PARAMS = "\
useradd -p '' tester; \
groupadd developers; \
userdel nobody; \
groupdel -g video; \
groupmod -g 1020 developers; \
usermod -s /bin/sh tester; \
"
</literallayout>
</para>
</section>
<section id='ref-classes-debian'>
<title>Debian Renaming - <filename>debian.bbclass</filename></title>

View File

@ -1788,6 +1788,40 @@
</glossdef>
</glossentry>
<glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm>
<glossdef>
<para>
When a recipe inherits the
<link linkend='ref-classes-extrausers'><filename>extrausers</filename></link>
class, this variable provides image level user and group
operations.
This is a more global method of providing user and group
configuration as compared to using the
<link linkend='ref-classes-useradd'><filename>useradd</filename></link>
class, which ties user and group configurations to a
specific recipe.
</para>
<para>
The set list of commands you can configure using the
<filename>EXTRA_USERS_PARAMS</filename> is shown in the
<filename>extrausers</filename> class.
These commands map to the normal Unix commands of the same
names:
<literallayout class='monospaced'>
# EXTRA_USERS_PARAMS = "\
# useradd -p '' tester; \
# groupadd developers; \
# userdel nobody; \
# groupdel -g video; \
# groupmod -g 1020 developers; \
# usermod -s /bin/sh tester; \
# "
</literallayout>
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-f'><title>F</title>