summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/ref-variables.xml135
1 files changed, 135 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 210d15099f..58b508e516 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7806,6 +7806,107 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7806 </glossdef> 7806 </glossdef>
7807 </glossentry> 7807 </glossentry>
7808 7808
7809 <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm>
7810 <glossdef>
7811 <para>
7812 Forces the OpenEmbedded build system to produce an error
7813 if the user identification (<filename>uid</filename>) and
7814 group identification (<filename>gid</filename>) values
7815 are not defined in <filename>files/passwd</filename>
7816 and <filename>files/group</filename> files.
7817 </para>
7818
7819 <para>
7820 The default behavior for the build system is to dynamically
7821 apply <filename>uid</filename> and
7822 <filename>gid</filename> values.
7823 Consequently, the <filename>USERADD_ERROR_DYNAMIC</filename>
7824 variable is by default not set.
7825 If you plan on using statically assigned
7826 <filename>gid</filename> and <filename>uid</filename>
7827 values, you should set
7828 the <filename>USERADD_ERROR_DYNAMIC</filename> variable in
7829 your <filename>local.conf</filename> file as
7830 follows:
7831 <literallayout class='monospaced'>
7832 USERADD_ERROR_DYNAMIC = "1"
7833 </literallayout>
7834 Overriding the default behavior implies you are going to
7835 also take steps to set static <filename>uid</filename> and
7836 <filename>gid</filename> values through use of the
7837 <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>,
7838 <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>,
7839 and
7840 <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
7841 variables.
7842 </para>
7843 </glossdef>
7844 </glossentry>
7845
7846 <glossentry id='var-USERADD_GID_TABLES'><glossterm>USERADD_GID_TABLES</glossterm>
7847 <glossdef>
7848 <para>
7849 Specifies a password file to use for obtaining static
7850 group identification (<filename>gid</filename>) values
7851 when the OpenEmbedded build system adds a group to the
7852 system during package installation.
7853 </para>
7854
7855 <para>
7856 The default behavior for the build system is to dynamically
7857 apply <filename>gid</filename> values.
7858 However, you can override this behavior by using the
7859 <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>
7860 variable.
7861 When you do use static values, you must also set the
7862 <filename>USERADD_GID_TABLES</filename> variable in your
7863 <filename>local.conf</filename> file as follows:
7864 <literallayout class='monospaced'>
7865 USERADD_GID_TABLES = "files/group"
7866 </literallayout>
7867 </para>
7868
7869 <note>
7870 When using static information for user adds, you must
7871 also use the
7872 <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>
7873 variable.
7874 </note>
7875 </glossdef>
7876 </glossentry>
7877
7878 <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm>
7879 <glossdef>
7880 <para>
7881 Specifies a password file to use for obtaining static
7882 user identification (<filename>uid</filename>) values
7883 when the OpenEmbedded build system adds a user to the
7884 system during package installation.
7885 </para>
7886
7887 <para>
7888 The default behavior for the build system is to dynamically
7889 apply <filename>uid</filename> values.
7890 However, you can override this behavior by using the
7891 <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>
7892 variable.
7893 When you do use static values, you must also set the
7894 <filename>USERADD_UID_TABLES</filename> variable in your
7895 <filename>local.conf</filename> file as follows:
7896 <literallayout class='monospaced'>
7897 USERADD_UID_TABLES = "files/passwd"
7898 </literallayout>
7899 </para>
7900
7901 <note>
7902 When using static information for group adds, you must
7903 also use the
7904 <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
7905 variable.
7906 </note>
7907 </glossdef>
7908 </glossentry>
7909
7809 <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> 7910 <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm>
7810 <glossdef> 7911 <glossdef>
7811 <para> 7912 <para>
@@ -7863,6 +7964,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7863 </para> 7964 </para>
7864 </glossdef> 7965 </glossdef>
7865 </glossentry> 7966 </glossentry>
7967
7968 <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENTION</glossterm>
7969 <glossdef>
7970 <para>
7971 When set to "useradd-staticids", causes the
7972 OpenEmbedded build system to base all user and group
7973 additions on a static
7974 <filename>passwd</filename> and
7975 <filename>group</filename> files.
7976 To use static user identification (<filename>uid</filename>)
7977 and group identification (<filename>gid</filename>)
7978 values, set the variable
7979 as follows in your <filename>local.conf</filename> file:
7980 <literallayout class='monospaced'>
7981 USERADDEXTENSION = "useradd-staticids"
7982 </literallayout>
7983 </para>
7984
7985 <para>
7986 If you use static <filename>uid</filename> and
7987 <filename>gid</filename> information, you must also
7988 specify the <filename>files/passwd</filename> and
7989 <filename>files/group</filename> files by setting the
7990 <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>
7991 and
7992 <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
7993 variables.
7994 Additionally, you should also set the
7995 <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link>
7996 variable.
7997 </para>
7998 </glossdef>
7999 </glossentry>
8000
7866 </glossdiv> 8001 </glossdiv>
7867 8002
7868<!-- <glossdiv id='var-glossary-v'><title>V</title>--> 8003<!-- <glossdiv id='var-glossary-v'><title>V</title>-->