Page MenuHomeFreeBSD
Differential D2700

Clarify pw(8) manual w/respect to required arguments.
ClosedPublic
Actions

Authored by dteske on May 31 2015, 10:53 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Mar 29, 2:21 AM
Unknown Object (File)
Tue, Mar 18, 3:16 PM
Unknown Object (File)
Mon, Mar 10, 11:26 AM
Unknown Object (File)
Sat, Mar 8, 7:34 PM
Unknown Object (File)
Feb 13 2025, 4:18 AM
Unknown Object (File)
Jan 27 2025, 7:10 PM
Unknown Object (File)
Jan 8 2025, 9:44 PM
Unknown Object (File)
Nov 24 2024, 6:27 AM
View All Files
Subscribers
imp
wblock

Details

Reviewers
eadler
allanjude
wblock
bapt
Group Reviewers
manpages
Commits
rS286258: Clarify pw(8) manual w/respect to required arguments. Break long lines at
Summary

Clarify pw(8) manual w/respect to required arguments. Break long lines at
punctuation while here.

MFC after: 3 days
X-MFC-to: stable/10

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

dteske updated this revision to Diff 5848.May 31 2015, 10:53 PM
dteske retitled this revision from to Clarify pw(8) manual w/respect to required arguments..
dteske updated this object.
dteske edited the test plan for this revision. (Show Details)
Herald added a reviewer: manpages. · View Herald TranscriptMay 31 2015, 10:53 PM
Herald added a subscriber: imp. · View Herald Transcript
dteske updated this object.May 31 2015, 10:57 PM
dteske edited edge metadata.
dteske added reviewers: bapt, allanjude.
dteske added a reviewer: eadler.May 31 2015, 11:10 PM
bapt accepted this revision.Jun 1 2015, 5:00 AM
bapt edited edge metadata.
This revision is now accepted and ready to land.Jun 1 2015, 5:00 AM
wblock added a subscriber: wblock.Jun 1 2015, 6:26 PM
wblock added inline comments.
usr.sbin/pw/pw.8
224 ↗(On Diff #5848)

If touching these lines, let's get rid of the informal use of "you":

Following these keywords,
the user or group name or numeric id may be optionally specified
as an alternative...

234 ↗(On Diff #5848)

"This flag" is not needed, and passive->active:

Set an alternate location for the password, group and configuration files.
Can be used to maintain...

329 ↗(On Diff #5848)

(you)

Usually, only one of these options is required,

330 ↗(On Diff #5848)

(you)
However, there are times when both are needed.

335 ↗(On Diff #5848)

(you)

To automatically allocate...

339 ↗(On Diff #5848)

(you)

then do

344 ↗(On Diff #5848)

(you)
Either the account or userid can also be provided immediately after the

364 ↗(On Diff #5848)

(you)
the comment must be enclosed in double quotes

374 ↗(On Diff #5848)

(you)
this is only used if the home directory is to be different from the

593 ↗(On Diff #5848)

This sentence is hard to decipher:

"Unlike use without"?
"when" is... weirdly used.

How about just eliminating that initial part that only tells what it is not like?

The numeric argument specifies the number of days after creation that the account expires.

Or fix the odd first part:

When used with
.Fl D ,
the argument must be numeric, and specifies the number of days after creation that the account expires.

632 ↗(On Diff #5848)

"These options" is redundant.

Set the minimum...

648 ↗(On Diff #5848)

Redundant use of "set":

option selects the default...

671 ↗(On Diff #5848)

which is suitable when users are issued passwords

672 ↗(On Diff #5848)

rather the allowing the user to select their own

dteske updated this revision to Diff 5871.Jun 1 2015, 9:54 PM
dteske edited edge metadata.

Incorporate suggestions from wblock

This revision now requires review to proceed.Jun 1 2015, 9:54 PM
dteske added a reviewer: wblock.Jun 1 2015, 9:55 PM
wblock added inline comments.Jun 2 2015, 5:33 PM
usr.sbin/pw/pw.8
587 ↗(On Diff #5871)

This is far easier to understand. But did the logic get switched around? The original seems to say that the argument to -e must be numeric when -D is used. (It's making my brain hurt: "unlike this, don't not do what that does unless not this other thing")

667 ↗(On Diff #5871)

"to access their accounts" is not needed.

dteske marked 13 inline comments as done.Jun 3 2015, 8:52 PM
dteske updated this revision to Diff 5927.Jun 3 2015, 9:25 PM

Address comments from wblock

dteske marked an inline comment as done.Jun 3 2015, 9:26 PM
wblock added inline comments.Jun 3 2015, 10:02 PM
usr.sbin/pw/pw.8
234 ↗(On Diff #5927)

Needs a serial comma after "group".

590 ↗(On Diff #5927)

This seems more confusing. It might help to be specific about which argument:

When
.Fl D
is used with
.Fl e ,
the argument to
.Fl e
represents the number of days after creation that the account expires, and must be numeric.

668 ↗(On Diff #5927)

Possibly simpler wording:

which is suitable when users are issued passwords rather than being allowed

dteske updated this revision to Diff 5928.Jun 3 2015, 10:40 PM

Rebase diff following r283692 (gjb)

wblock added inline comments.Jun 3 2015, 11:19 PM
usr.sbin/pw/pw.8
590 ↗(On Diff #5927)

Trying for simpler:

When
.Fl D
is used, the
.Ar days
argument is interpreted differently.
It must be numeric, and represents the number of days after creation that the account expires.

dteske updated this revision to Diff 6388.Jun 23 2015, 3:38 AM

Incorporate latest comments from wblock

dteske marked 6 inline comments as done.Jun 23 2015, 3:39 AM
wblock accepted this revision.Jun 23 2015, 3:38 PM
wblock edited edge metadata.

Looks good. Please check with igor and mandoc -Tlint before commit. Thanks!

This revision is now accepted and ready to land.Jun 23 2015, 3:38 PM
Closed by commit rS286258: Clarify pw(8) manual w/respect to required arguments. Break long lines at (authored by dteske). · Explain WhyAug 3 2015, 9:19 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
head/
usr.sbin/
pw/
210 lines

Diff 7622

View Options

head/usr.sbin/pw/pw.8

Loading...