Commit Graph

5 Commits

Author SHA1 Message Date
Mateusz Piotrowski
6d33315d2f Cross-reference style(9) and style.mdoc(5)
Suggested by:	yuripv
MFC after:	3 days
2020-06-30 16:23:51 +00:00
Mateusz Piotrowski
ca588aed6d style.mdoc.5: Fix formatting issues
Reviewed by:	bcr
Approved by:	bcr (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D19532
2019-03-10 20:58:59 +00:00
Mateusz Piotrowski
6e33d37f86 style.mdoc.5: Fix a typo
Reviewed by:	eadler
Approved by:	eadler (doc)
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D19328
2019-02-24 14:20:47 +00:00
Mateusz Piotrowski
e84f645584 style.mdoc.5: Suggest preferred formatting for EXAMPLES
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.

Reviewed by:	bcr
Approved by:	bcr (doc),
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18681
2018-12-29 23:00:20 +00:00
Mateusz Piotrowski
13bf4d9e88 Add a style.mdoc(5) manual page.
The aim of this manual page is to act as a style and formatting guide for
mdoc(7) manual pages. Currently, mdoc(7) does not provide much guidance
when it comes to the usage of macros making it difficult to format manual
pages in a consistent way.

Reviewed by:	bcr
Approved by:	bcr (doc), krion (mentor, implicit), mat (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D18394
2018-12-28 19:49:58 +00:00