summaryrefslogtreecommitdiffstats
path: root/docs/GROUP_RECORD.md
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2020-08-06 17:44:57 +0200
committerLennart Poettering <lennart@poettering.net>2020-08-07 08:39:56 +0200
commit072779f0bf85cd4d15b9a9f39479af5a8247c238 (patch)
tree9c0e1d6e8a876f0d7f0c0e0db92ef77f3fd61954 /docs/GROUP_RECORD.md
parentcore,home,machined: generate description fields for all groups we synthesize (diff)
downloadsystemd-072779f0bf85cd4d15b9a9f39479af5a8247c238.tar.xz
systemd-072779f0bf85cd4d15b9a9f39479af5a8247c238.zip
docs: document new description field
Also, explain GECOS syntax requirements.
Diffstat (limited to 'docs/GROUP_RECORD.md')
-rw-r--r--docs/GROUP_RECORD.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/GROUP_RECORD.md b/docs/GROUP_RECORD.md
index 2ea0b73a36..01800494da 100644
--- a/docs/GROUP_RECORD.md
+++ b/docs/GROUP_RECORD.md
@@ -22,6 +22,10 @@ UNIX/glibc NSS `struct group`, or the shadow structure `struct sgrp`'s
`realm` → The "realm" the group belongs to, conceptually identical to the same
field of user records. A string in DNS domain name syntax.
+`description` → A descriptive string for the group. This is similar to the
+`realName` field of user records, and accepts arbitrary strings, as long as
+they follow the same GECOS syntax requirements as `realName`.
+
`disposition` → The disposition of the group, conceptually identical to the
same field of user records. A string.