From: Lennart Poettering Date: Thu, 6 Aug 2020 15:44:57 +0000 (+0200) Subject: docs: document new description field X-Git-Tag: v247-rc1~434^2~1 X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fsystemd.git;a=commitdiff_plain;h=072779f0bf85cd4d15b9a9f39479af5a8247c238 docs: document new description field Also, explain GECOS syntax requirements. --- diff --git a/docs/GROUP_RECORD.md b/docs/GROUP_RECORD.md index 2ea0b73a365..01800494da7 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. diff --git a/docs/USER_RECORD.md b/docs/USER_RECORD.md index f6d22c217b0..960a82d8949 100644 --- a/docs/USER_RECORD.md +++ b/docs/USER_RECORD.md @@ -221,12 +221,14 @@ optional, when unset the user should not be considered part of any realm. A user record with a realm set is never compatible (for the purpose of updates, see above) with a user record without one set, even if the `userName` field matches. -`realName` → The real name of the user, a string. This should contain the user's -real ("human") name, and corresponds loosely to the GECOS field of classic UNIX -user records. When converting a `struct passwd` to a JSON user record this -field is initialized from GECOS (i.e. the `pw_gecos` field), and vice versa -when converting back. That said, unlike GECOS this field is supposed to contain -only the real name and no other information. +`realName` → The real name of the user, a string. This should contain the +user's real ("human") name, and corresponds loosely to the GECOS field of +classic UNIX user records. When converting a `struct passwd` to a JSON user +record this field is initialized from GECOS (i.e. the `pw_gecos` field), and +vice versa when converting back. That said, unlike GECOS this field is supposed +to contain only the real name and no other information. This field must not +contain control characters (such as `\n`) or colons (`:`), since those are used +as record separators in classic `/etc/passwd` files and similar formats. `emailAddress` → The email address of the user, formatted as string. [`pam_systemd`](https://www.freedesktop.org/software/systemd/man/pam_systemd.html)