Clarify documentation regarding creation of homedir#1523
Conversation
|
I desired I can add a Signed-Off tag tomorrow, I just did this quickly via the GH web UI as I'm calling it a day right now. |
ikerexxe
left a comment
There was a problem hiding this comment.
While this is an improvement the text is still quite confusing. I'd propose to make a complete rewrite of this section to clarify the beaviour by separating it by user type.
My proposal would be the following:
Home directory creation behavior:
The directory HOME_DIR is not created by default. Whether it gets created depends on the user type and command-line options:
- For regular users: the home directory will be created if either the -m flag is specified or if CREATE_HOME is set to yes in /etc/login.defs.
- For system users (created with -r): the home directory will only be created if the -m flag is explicitly specified, regardless of the CREATE_HOME setting.
- Override: the -M flag prevents home directory creation in all cases, overriding any other settings.
Feel free to reword or improve anything as it might contain errors.
I have some wording tweaks for the following suggested text:
|
|
Ping. Cc: @septatrix |
121e9bb to
92d1cff
Compare
| For regular users, the home directory is created if either the | ||
| <option>-m</option> flag is specified or <replaceable>CREATE_HOME</replaceable> | ||
| in <citerefentry> | ||
| <refentrytitle>login.defs</refentrytitle><manvolnum>5</manvolnum> | ||
| </citerefentry> is set to true. |
There was a problem hiding this comment.
Please use semantic newlines in new paragraphs. See man-pages(7):
$ MANWIDTH=72 man man-pages | awk '/Use semantic newlines/,/^$/'
Use semantic newlines
In the source of a manual page, new sentences should be started on
new lines, long sentences should be split into lines at clause
breaks (commas, semicolons, colons, and so on), and long clauses
should be split at phrase boundaries. This convention, sometimes
known as "semantic newlines", makes it easier to see the effect of
patches, which often operate at the level of individual sentences,
clauses, or phrases.
There was a problem hiding this comment.
I assume you mean the long line with CREATE_HOME in it?
The "for non-system users" only applies to the CREATE_HOME config and is does not matter when using the `-m` flag. Signed-off-by: Septatrix <24257556+septatrix@users.noreply.github.com>
The "for non-system users" only applies to the CREATE_HOME config and is does not matter when using the
-mflag.Fixes #1522.