Page MenuHomeFreeBSD
Differential D15350

Tidy up ports.7 manual
ClosedPublic
Actions

Authored by 0mp on May 8 2018, 11:32 AM.
Tags
Referenced Files
Unknown Object (File)
Sat, Dec 21, 10:58 AM
Unknown Object (File)
Sat, Dec 21, 9:12 AM
Unknown Object (File)
Sat, Dec 21, 6:09 AM
Unknown Object (File)
Nov 25 2024, 2:35 AM
Unknown Object (File)
Nov 24 2024, 9:20 AM
Unknown Object (File)
Nov 19 2024, 4:52 PM
Unknown Object (File)
Oct 17 2024, 4:24 PM
Unknown Object (File)
Sep 27 2024, 7:51 PM
View All 78 Files
Subscribers
bjk
imp
manpages

Details

Reviewers
krion
mat
bcr
eadler
Group Reviewers
manpages
Commits
rS337905: Tidy up the ports.7 manual page.
Summary

Changes:

  • Use .Dq Li for inline commands.
  • Reference pkg(8) is not installed by default. pkg(7) is. Reference pkg(7) first and then pkg(8) in additional documentation.
  • Fix some style problems.
  • Reword some sentences.
  • Reference additional documentation.
Test Plan
  • igor ok
  • mandoc -Tlint ok

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 18166
Build 17900: arc lint + arc unit

Event Timeline

0mp created this revision.May 8 2018, 11:32 AM
Herald added a subscriber: imp. · View Herald TranscriptMay 8 2018, 11:33 AM
0mp updated this revision to Diff 45535.Jul 19 2018, 12:31 PM

Update the patch after recent changes to ports.7.

Harbormaster completed remote builds in B18166: Diff 45535.Jul 19 2018, 12:31 PM
0mp edited the summary of this revision. (Show Details)Jul 19 2018, 12:36 PM
0mp edited the test plan for this revision. (Show Details)
0mp added reviewers: krion, mat.
mat accepted this revision.Jul 20 2018, 11:34 AM
mat added 1 blocking reviewer(s): manpages.

No idea what this is/does.

bjk added a subscriber: bjk.Jul 24 2018, 12:46 AM

Can you remind me why the .Dq Li is supposed to be better for inline commands?

0mp added a comment.Jul 31 2018, 1:27 AM
In D15350#348437, @bjk wrote:

Can you remind me why the .Dq Li is supposed to be better for inline commands?

As fair as I know we tend to use Dq Li instead of Nm make Cm build-like for inline commands. This is the style we follow in make.conf.5, src.conf.5, mqueufs.5. The Nm-based formatting is used in rc.conf.5 and find.1 on the other hand.

AFAICT, Dq Li is a more popular way to format commands.

The argument which is in favor of Dq Li is that we tend to make commands in Examples sections literal. We very rarely add Nm-like formatting to examples. Hence for the sake of consistency I'm proposing this change from Nm ... to Dq Li. 😄

What do you think about it, @bjk?

0mp added a reviewer: bcr.Aug 15 2018, 1:55 PM
eadler accepted this revision.Aug 16 2018, 5:15 AM
This revision is now accepted and ready to land.Aug 16 2018, 5:15 AM
krion accepted this revision.Aug 16 2018, 6:53 AM
Closed by commit rS337905: Tidy up the ports.7 manual page. (authored by 0mp). · Explain WhyAug 16 2018, 1:29 PM
This revision was automatically updated to reflect the committed changes.
bjk added a comment.Aug 16 2018, 2:55 PM
In D15350#350715, @0mp wrote:
In D15350#348437, @bjk wrote:

Can you remind me why the .Dq Li is supposed to be better for inline commands?

As fair as I know we tend to use Dq Li instead of Nm make Cm build-like for inline commands. This is the style we follow in make.conf.5, src.conf.5, mqueufs.5. The Nm-based formatting is used in rc.conf.5 and find.1 on the other hand.

AFAICT, Dq Li is a more popular way to format commands.

The argument which is in favor of Dq Li is that we tend to make commands in Examples sections literal. We very rarely add Nm-like formatting to examples. Hence for the sake of consistency I'm proposing this change from Nm ... to Dq Li. 😄

What do you think about it, @bjk?

I see this is basically overcome by events, but thank you for the explanation/research -- your proposal seems reasonable to me.

0mp added a comment.Aug 16 2018, 3:26 PM
In D15350#356103, @bjk wrote:
In D15350#350715, @0mp wrote:
In D15350#348437, @bjk wrote:

Can you remind me why the .Dq Li is supposed to be better for inline commands?

As fair as I know we tend to use Dq Li instead of Nm make Cm build-like for inline commands. This is the style we follow in make.conf.5, src.conf.5, mqueufs.5. The Nm-based formatting is used in rc.conf.5 and find.1 on the other hand.

AFAICT, Dq Li is a more popular way to format commands.

The argument which is in favor of Dq Li is that we tend to make commands in Examples sections literal. We very rarely add Nm-like formatting to examples. Hence for the sake of consistency I'm proposing this change from Nm ... to Dq Li. 😄

What do you think about it, @bjk?

I see this is basically overcome by events, but thank you for the explanation/research -- your proposal seems reasonable to me.

Thanks, @bjk. :)

Revision Contents
Changeset List

PathSize
share/
man/
man7/
56 lines

Diff 45535

View Options

share/man/man7/ports.7

Loading...