Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 693964 - devmanual: GLEP81 user data guidelines
Summary: devmanual: GLEP81 user data guidelines
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-09-10 01:49 UTC by Michael Orlitzky
Modified: 2020-01-23 13:36 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch (0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch,8.05 KB, patch)
2019-09-10 01:51 UTC, Michael Orlitzky
Details | Diff
0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch (0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch,8.03 KB, patch)
2019-09-10 01:54 UTC, Michael Orlitzky
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Comment 1 Michael Orlitzky gentoo-dev 2019-09-10 01:51:51 UTC
Created attachment 589600 [details, diff]
0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch

The only difference from the patch sent to the mailing list is that this one makes an attempt to follow the devmanual's style guidelines.
Comment 2 Michael Orlitzky gentoo-dev 2019-09-10 01:54:52 UTC
Created attachment 589602 [details, diff]
0001-ebuild-writing-users-and-groups-GLEP-81-user-data-gu.patch
Comment 3 Michael Orlitzky gentoo-dev 2019-11-03 13:36:59 UTC
If no one has any objections, I'm going to use my newfound ability to push this myself. Users keep posting RFCs that use /var/lib/$PN as home, and I have no where to point them except to an old mailing list thread or an unresolved bug.

The contents of the patch were already reviewed on -dev.
Comment 4 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2019-11-03 13:46:16 UTC
Could you post it on GitHub for completeness?  It's better if all major changes go through the same pipeline, not to mention I don't really want to fight Bugzilla to review it.
Comment 5 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2019-11-03 13:50:08 UTC
For the record, my concern with those changes is that they introduce a lot of text.  It would be nice to have some short summary on top, and make reading the detailed information optional.  I suppose most of the users will be happy with 'do not set this, that or that.  If you really want to set them, see below'.
Comment 6 Michael Orlitzky gentoo-dev 2019-11-03 14:00:05 UTC
https://github.com/gentoo/devmanual.gentoo.org/pull/116
Comment 7 Michael Orlitzky gentoo-dev 2019-11-21 15:12:38 UTC
(In reply to Michał Górny from comment #5)
> I suppose most of the users will be happy with 'do not set this, that or that.  > If you really want to set them, see below'.

There's already a big blue box that says

  Important: Whenever possible, the default shell and home directory should be 
  used. The rationale for this is explained below. 

but today I had to wake up and comment on ANOTHER pull request making the same mistake, because this documentation has told people to do the wrong thing for 4 months now.

I'm just going to put the damned thing on my website. At least then I can reduce my comments on these PRs down to copy/pasting a link.
Comment 8 Larry the Git Cow gentoo-dev 2019-12-10 02:32:04 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9613e9e69ae16e6981f90135f92811ded641b52c

commit 9613e9e69ae16e6981f90135f92811ded641b52c
Author:     Michael Orlitzky <mjo@gentoo.org>
AuthorDate: 2019-09-01 16:17:41 +0000
Commit:     Göktürk Yüksek <gokturk@gentoo.org>
CommitDate: 2019-12-10 02:31:26 +0000

    ebuild-writing/users-and-groups: GLEP 81 user data guidelines.
    
    GLEP 81 significantly changes the way that user management is handled,
    and reveals some subtle issues in existing packages that have remained
    hidden until now. Many of these issues can be avoided (in GLEP 81, but
    also in general) by exercising some discipline when choosing the data
    for new users and groups:
    
      * User and group names
      * Default shell
      * Home directory
      * Home directory ownership and permissions
    
    This commit adds a few new sections to the "Users and Groups" chapter
    that explain the current best practices, and give suggestions for
    choosing the user and group data listed above. The rationale for these
    choices is explained, and some notable exceptions are mentioned.
    
    Closes: https://bugs.gentoo.org/693964
    Closes: https://github.com/gentoo/devmanual/pull/116
    Signed-off-by: Michael Orlitzky <mjo@gentoo.org>
    Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>

 ebuild-writing/users-and-groups/text.xml | 169 +++++++++++++++++++++++++++++++
 1 file changed, 169 insertions(+)