Page MenuHomeFreeBSD
Differential D18681

style.mdoc.5: Suggest preferred formatting for EXAMPLES
ClosedPublic
Actions

Authored by 0mp on Dec 29 2018, 5:53 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Nov 2, 8:58 PM
Unknown Object (File)
Sun, Nov 2, 8:58 PM
Unknown Object (File)
Sun, Nov 2, 8:58 PM
Unknown Object (File)
Sun, Nov 2, 4:24 PM
Unknown Object (File)
Jun 22 2025, 3:31 AM
Unknown Object (File)
Jun 21 2025, 3:31 AM
Unknown Object (File)
Jun 20 2025, 6:37 PM
Unknown Object (File)
Jun 19 2025, 3:28 AM
View All 66 Files
Subscribers
imp

Details

Reviewers
bcr
eadler
Group Reviewers
manpages
docs
Commits
rS342600: style.mdoc.5: Suggest preferred formatting for EXAMPLES
Summary

Add an example of how to format examples in EXAMPLES sections. The suggested
format is heavily based on zfs.8.

While here, capitalize subsection titles.

Test Plan

igor, mandoc

Diff Detail

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

Event Timeline

0mp created this revision.Dec 29 2018, 5:53 PM
Herald added a reviewer: manpages. · View Herald TranscriptDec 29 2018, 5:53 PM
Herald added a subscriber: imp. · View Herald Transcript
Harbormaster completed remote builds in B21763: Diff 52396.Dec 29 2018, 5:53 PM
0mp added a reviewer: docs.Dec 29 2018, 5:53 PM
bcr added a comment.Dec 29 2018, 9:27 PM

Question about the "No"...

share/man/man5/style.mdoc.5
79 ↗(On Diff #52396)

Is it "Now" or "Not" instead of "No" here?

85 ↗(On Diff #52396)

and here?

0mp marked 2 inline comments as done.Dec 29 2018, 9:29 PM
0mp added inline comments.
share/man/man5/style.mdoc.5
79 ↗(On Diff #52396)

Haha, no, it is a macro, No, for normal text, without any formatting.

0mp marked an inline comment as done.Dec 29 2018, 9:30 PM
0mp added inline comments.
share/man/man5/style.mdoc.5
79 ↗(On Diff #52396)

It is required to make the title of an example not bold.

bcr accepted this revision.Dec 29 2018, 9:32 PM

Ah, got it. Fine then. Thanks for the clarification.

This revision is now accepted and ready to land.Dec 29 2018, 9:32 PM
Closed by commit rS342600: style.mdoc.5: Suggest preferred formatting for EXAMPLES (authored by 0mp). · Explain WhyDec 29 2018, 11:00 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
head/
share/
man/
man5/
52 lines

Diff 52416

View Options

head/share/man/man5/style.mdoc.5

Loading...