Update rc.conf.5 for jail_list and jail_reverse_stop
ClosedPublic
Actions

Authored by feld on Feb 10 2016, 4:34 PM.

Details

Reviewers

jamie
wblock

Group Reviewers

manpages

Commits

rS295568: Document the new jail_reverse_stop parameter

Summary

Add entry for jail_reverse stop

Also, the current wording of jail_list seems wrong. It doesn't mention
that it controls startup order and this is the wrong place to cover the
limits of jail naming conventions.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

feld updated this revision to Diff 13184.Feb 10 2016, 4:34 PM

feld retitled this revision from to Update rc.conf.5 for jail_list and jail_reverse_stop.

feld updated this object.

feld edited the test plan for this revision. (Show Details)

feld added a reviewer: jamie.

Herald added a reviewer: manpages. · View Herald TranscriptFeb 10 2016, 4:34 PM

Herald added a subscriber: imp. · View Herald Transcript

wblock added a subscriber: wblock.Feb 10 2016, 4:49 PM

wblock added inline comments.

share/man/man5/rc.conf.5
3856 ↗	(On Diff #13184)	Nice! The compound word: "space-separated" makes more sense to me here.
3858 ↗	(On Diff #13184)	Not yours, but "all of jail(8) instances in..." is missing an article or something. And "configured" is weak, seems like it should be "acted on" or "affected" or something. And since we really have way too many halting if/then sentences, how about: When left empty, all of the .Xr jail 8 instances defined in the configuration file will be acted on.
3861 ↗	(On Diff #13184)	Since we are here, let's do the passive->active thing, and not just s/will be/are/ but make it simpler: `The names specified in this list``
3866 ↗	(On Diff #13184)	or maybe clearer to say "must be started manually."?
3869 ↗	(On Diff #13184)	s/If/When/, just for variety.
3873 ↗	(On Diff #13184)	s/will be/are/

allanjude added a subscriber: allanjude.Feb 10 2016, 5:38 PM

allanjude added inline comments.

share/man/man5/rc.conf.5
3856 ↗	(On Diff #13184)	the other option is space delimited
3858 ↗	(On Diff #13184)	acted upon?

I'm kind of late to the game, but it looks good to me (as do most of the inline suggestions)

share/man/man5/rc.conf.5
3857 ↗	(On Diff #13184)	The bit about the variable being empty would fit better after saying what it does (when not empty). And perhaps instead of "If this variable is empty, ..." something like "By default, ..."
3858 ↗	(On Diff #13184)	Later you mention missing jails not being started automatically. So instead of "acted on", how about "started"? ("/stopped" will be assumed by the astute reader).

This revision is now accepted and ready to land.Feb 10 2016, 10:07 PM

I think I've sufficiently addressed all of these comments in the next revision landing in a moment...

Update verbiage based on feedback

This revision now requires review to proceed.Feb 11 2016, 9:33 PM

Herald edited edge metadata. · View Herald TranscriptFeb 11 2016, 9:33 PM

Looks good to me. Please remember to run igor -R (which will point out about updating .Dd) and mandoc -tlint on it before commit. Oh, and please remember to mark it for MFC. Thanks!

This revision is now accepted and ready to land.Feb 11 2016, 9:49 PM

jamie accepted this revision.Feb 11 2016, 11:31 PM

jamie edited edge metadata.

Closed by commit rS295568: Document the new jail_reverse_stop parameter (authored by feld). · Explain WhyFeb 12 2016, 5:55 PM

This revision was automatically updated to reflect the committed changes.