Differential D55298

style.mdoc: Remove synopsis formatting advice
ClosedPublic
Actions

Authored by ziaee on Mon, Feb 16, 6:41 AM.

Tags

None

Referenced Files

	Unknown Object (File)
	Thu, Mar 5, 3:31 AM

	Unknown Object (File)
	Thu, Mar 5, 3:06 AM

	Unknown Object (File)
	Wed, Mar 4, 10:26 PM

	Unknown Object (File)
	Sun, Mar 1, 9:36 AM

	Unknown Object (File)
	Sat, Feb 28, 3:54 PM

	Unknown Object (File)
	Sat, Feb 28, 8:22 AM

	Unknown Object (File)
	Fri, Feb 27, 8:15 PM

	Unknown Object (File)
	Wed, Feb 25, 9:01 AM

View All 16 Files

Subscribers

Details

Reviewers

Group Reviewers

Commits

rG47326cb47027: style.mdoc: Remove synopsis formatting advice

Summary

We use a space between pipes, as even restaurant menus do.
The advice on using Cm is in conflict with the Cm examples in mdoc(7).

MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

ziaee created this revision.Mon, Feb 16, 6:41 AM

Herald added a subscriber: imp. · View Herald TranscriptMon, Feb 16, 6:41 AM

ziaee requested review of this revision.Mon, Feb 16, 6:41 AM

Harbormaster completed remote builds in B70685: Diff 171951.Mon, Feb 16, 6:41 AM

ziaee added a parent revision: D55297: style.mdoc: Li macro is undeprecated for some time.Mon, Feb 16, 6:46 AM

ziaee added a child revision: D55299: style.mdoc: Explain why not to abuse Nm.

ziaee edited the summary of this revision. (Show Details)Mon, Feb 16, 6:55 AM

ziaee added reviewers: 0mp, manpages.

The reason it's a problem to have this text which is in conflict with the language reference is because then people both have to read more and will be confused because we have two concurrent docs saying conflicting things.

This revision was not accepted when it landed; it landed in state Needs Review.Mon, Mar 2, 11:15 AM

Closed by commit rG47326cb47027: style.mdoc: Remove synopsis formatting advice (authored by ziaee). · Explain Why

This revision was automatically updated to reflect the committed changes.

ziaee added a commit: rG47326cb47027: style.mdoc: Remove synopsis formatting advice.

Revision Contents
Changeset List

Path

Size

share/

man/

man5/

67 lines

Diff 173002

share/man/man5/style.mdoc.5

Loading...