[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/users-and-groups/

[Ulrich Müller]

commit:     56eb6bc591c3daff893e9060faed0c04b4adb7f1
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Jan 23 19:29:35 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Jan 23 19:29:35 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=56eb6bc5

ebuild-writing/users-and-groups: Use example ebuilds from tree.

The acct-user/group ebuilds for suricata are rather typical examples,
so replace the fictitious user 123 by them.

This also has ${PN} as single element in ACCT_USER_GROUPS, and it
drops the uncommon ACCT_USER_{SHELL,HOME{,_OWNER,_PERMS}} variables
from the example.

Original patch from Michael Orlitzky <mjo <AT> gentoo.org> (who asked me to
put my own name on it).

Closes: https://bugs.gentoo.org/702508
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/users-and-groups/text.xml | 22 +++++++++-------------
 1 file changed, 9 insertions(+), 13 deletions(-)

diff --git a/ebuild-writing/users-and-groups/text.xml b/ebuild-writing/users-and-groups/text.xml
index 184f890..294d558 100644
--- a/ebuild-writing/users-and-groups/text.xml
+++ b/ebuild-writing/users-and-groups/text.xml
@@ -42,8 +42,8 @@ and must not be used for new packages.
 
 <p>
 Group ebuilds are placed in <c>acct-group</c> category, with the package name
-matching the group name.  The following can be used as a template for writing
-group ebuilds:
+matching the group name. The following ebuild for <c>acct-group/suricata</c>
+can be used as a template for writing group ebuilds:
 </p>
 
 <pre>
@@ -54,8 +54,8 @@ EAPI=7
 
 inherit acct-group
 
-DESCRIPTION="Meaningful description of the group"
-ACCT_GROUP_ID=123
+DESCRIPTION="Group for Suricata IDS"
+ACCT_GROUP_ID=477
 </pre>
 
 <p>
@@ -71,8 +71,8 @@ ACCT_GROUP_ID=123
 
 <p>
 User ebuilds are placed in <c>acct-user</c> category, with the package name
-matching the user name.  The following can be used as a template for writing
-user ebuilds:
+matching the user name. The following ebuild for <c>acct-user/suricata</c>
+can be used as a template for writing user ebuilds:
 </p>
 
 <pre>
@@ -83,13 +83,9 @@ EAPI=7
 
 inherit acct-user
 
-DESCRIPTION="Meaningful description of the user"
-ACCT_USER_ID=123
-ACCT_USER_SHELL=/usr/bin/foo
-ACCT_USER_HOME=/var/lib/foo
-ACCT_USER_HOME_OWNER=foo:bar
-ACCT_USER_HOME_PERMS=0775
-ACCT_USER_GROUPS=( foo bar baz )
+DESCRIPTION="User for Suricata IDS"
+ACCT_USER_ID=477
+ACCT_USER_GROUPS=( ${PN} )
 
 acct-user_add_deps
 </pre>