Page MenuHomeFreeBSD
Differential D57921

resolver(5): Overhaul
ClosedPublic
Actions

Authored by des on Sun, Jun 28, 8:13 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Jul 14, 12:06 AM
Unknown Object (File)
Mon, Jul 13, 10:05 AM
Unknown Object (File)
Sat, Jul 11, 4:36 PM
Unknown Object (File)
Fri, Jul 10, 11:11 PM
Unknown Object (File)
Thu, Jul 9, 9:40 PM
Unknown Object (File)
Wed, Jul 8, 7:01 AM
Unknown Object (File)
Mon, Jul 6, 11:19 PM
Unknown Object (File)
Mon, Jul 6, 10:13 PM
View All Files
Subscribers
imp
ziaee

Details

Reviewers
kevans
markj
Group Reviewers
manpages
Commits
rG4319e4bf42f2: resolver(5): Overhaul
Summary
  • Modernize the markup
  • Describe the comment syntax
  • Drop obsolete advice
  • Capitalize sentences
  • Improve the language
  • Replace no_tld_query with no-tld-query; both are supported, but all the other multi-word options use hyphens rather than underscores.
  • Add missing ENVIRONMENT section
  • Redo the example

MFC after: 1 week

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 74348
Build 71231: arc lint + arc unit

Event Timeline

des created this revision.Sun, Jun 28, 8:13 AM
Herald added subscribers: ziaee, imp. · View Herald TranscriptSun, Jun 28, 8:13 AM
des requested review of this revision.Sun, Jun 28, 8:13 AM
des added a child revision: D57922: libc/resolv: Drop Solaris 2 compatibility.
Harbormaster completed remote builds in B74348: Diff 180850.Sun, Jun 28, 8:14 AM
ziaee added a reviewer: manpages.Sun, Jun 28, 9:08 PM

Thank you so much for doing this!

share/man/man5/resolver.5
91

We should use the imperative tone

121

ditto

126

ditto

130

ditto

146

Ditto

159

ditto

169

ditto

176

Ditto

183

ditto

185
189

ditto

191
195

ditto

197
200

ditto

209

Ditto

211
260

I was talking with Kriszaps, the original mandoc author, about traditions in the manpages and we had a long tangent about how these are not sentences so traditionally we did not capitalize or punctuate them, and I think that's quite nice.

263–283

Can we modernize the examples too? This will facilitate them wrapping better, and also apropos has the option to search examples in the manual.

des added inline comments.Thu, Jul 2, 1:05 AM
share/man/man5/resolver.5
263–283

That's not “modernizing the example”, that's turning an example of a complete resolver configuration into a list of examples of resolver configuration fragments.

des updated this revision to Diff 181207.Thu, Jul 2, 1:49 AM

rf

Harbormaster completed remote builds in B74475: Diff 181207.Thu, Jul 2, 1:50 AM
des updated this revision to Diff 181208.Thu, Jul 2, 1:52 AM
des marked 17 inline comments as done.

for real this time

Harbormaster completed remote builds in B74476: Diff 181208.Thu, Jul 2, 1:52 AM
des marked an inline comment as done.Thu, Jul 2, 1:52 AM
markj accepted this revision.Thu, Jul 2, 2:06 PM
This revision is now accepted and ready to land.Thu, Jul 2, 2:06 PM
Closed by commit rG4319e4bf42f2: resolver(5): Overhaul (authored by des). · Explain WhyMon, Jul 6, 12:24 PM
This revision was automatically updated to reflect the committed changes.
des added a commit: rG4319e4bf42f2: resolver(5): Overhaul.

Revision Contents
Changeset List

PathSize
share/
man/
man5/
197 lines

Diff 180850

View Options

share/man/man5/resolver.5

Loading...