Page MenuHomeFreeBSD

Improve the markup of the ctld.conf man page
ClosedPublic

Authored by allanjude on Sep 7 2014, 12:57 AM.
Tags
None
Referenced Files
Unknown Object (File)
Nov 17 2024, 8:55 AM
Unknown Object (File)
Nov 12 2024, 3:05 PM
Unknown Object (File)
Nov 10 2024, 8:59 PM
Unknown Object (File)
Nov 2 2024, 9:20 PM
Unknown Object (File)
Oct 18 2024, 10:27 PM
Unknown Object (File)
Oct 7 2024, 11:09 PM
Unknown Object (File)
Oct 7 2024, 2:01 AM
Unknown Object (File)
Oct 2 2024, 3:13 AM
Subscribers
None

Details

Summary

Replace <var> with man page markup
Change sub-headings from 'command level' to 'command context'

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

allanjude retitled this revision from to Improve the markup of the ctld.conf man page.
allanjude updated this object.
allanjude edited the test plan for this revision. (Show Details)
allanjude added reviewers: bcr, wblock, eadler, trasz.

Looks great, apart from a few nits below.

usr.sbin/ctld/ctl.conf.5
71–72

"Context" name is much better than "level", but it's still kind of inconsistent - few lines below it says "Opens a target configuration section". Perhaps we should call it "Global section" instead, or change "section" to "context" everywhere?

72

Perhaps the whole "The following statements are available at ..." line could be dropped, since it's redundant? Same for similar lines for other contexts.

240–241

The "/ prefixlen" part is optional; can it be reflected somehow? Same for the other initiator-portal occurrence below.

allanjude edited edge metadata.

Added a lot more markup, and made it more consistent
Improved the sentence flow
Normalized some of the text.

Change the order of some definitions from:

  1. Description
  2. what happens if you don't define it
  3. otherwise, this happens (if it is defined)

to the more logical flow of:

  1. Description
  2. What happens when it is defined
  3. What happens when it is not defined
trasz edited edge metadata.

Looks perfect, thanks!

This revision is now accepted and ready to land.Sep 7 2014, 6:53 PM
allanjude edited edge metadata.

Cross-refrence the ctladm(8) man page for CTL-specific options

usr.sbin/ctld/ctl.conf.5
75

Active: s/Creates/Create/

81

In this and following entries, "Specifies" is redundant. This can just be
"The debug verbosity level."

93

s/Creates/Create/

98

s/Creates/Create/

158

s/Assigns/Assign/

184

s/Assigns/Assign/

187

s/Assigns/Assign/

Apply fixes suggested by wblock@

bcr edited edge metadata.

I make it a point not to disagree with trasz when he is right and has approved a man page. ;-)

allanjude edited edge metadata.

Update man page for commit

Committed as rS271445 and fixed in rS271446

usr.sbin/ctld/ctl.conf.5
72

Yes, I'd say remove it, it is redundant.

If we kept it, I'd reword it as "The following configuration directives are available in the Global Context"

240–241

Square brackets [] are generally used to denote optional arguments. I'll add those

Edward pointed out an ambiguity in the text

This revision is now accepted and ready to land.Sep 13 2014, 6:41 PM

I'm fine with the proposed fix = approved!

wblock edited edge metadata.