History log of /freebsd-current/share/man/man5/style.mdoc.5
Revision Date Author Comments
# e7ff9170 12-Apr-2024 Alexander Ziaee <concussious@runbox.com>

style.mdoc.5: maintenence

- description: increase visibility by s/file/manual page/
- examples: s/No Doing Something/Doing Something/
- examples: remove depreciated .Li macro
- examples: remove extra newline (one display block)
- see also: link roff language reference for mandoc

Reviewed by: imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/1130


# fa9896e0 16-Aug-2023 Warner Losh <imp@FreeBSD.org>

Remove $FreeBSD$: two-line nroff pattern

Remove /^\.\\"\n\.\\"\s*\$FreeBSD\$$\n/


# 4d846d26 10-May-2023 Warner Losh <imp@FreeBSD.org>

spdx: The BSD-2-Clause-FreeBSD identifier is obsolete, drop -FreeBSD

The SPDX folks have obsoleted the BSD-2-Clause-FreeBSD identifier. Catch
up to that fact and revert to their recommended match of BSD-2-Clause.

Discussed with: pfg
MFC After: 3 days
Sponsored by: Netflix


# 79afae3b 29-Jan-2022 Mateusz Piotrowski <0mp@FreeBSD.org>

style.mdoc.5: Document the conventions for -width

Reviewed by: debdrup
MFC after: 2 weeks
Differential Revision: https://reviews.freebsd.org/D33394


# 5e077e08 01-Dec-2021 Mateusz Piotrowski <0mp@FreeBSD.org>

style.mdoc: Prefer Ql to Dq Li for literal display

The Li macros has been deprecated by mdoc some time ago. Recommend the
use of Ql instead.

Reviewed by: debdrup
MFC after: 1 week
Differential Revision: https://reviews.freebsd.org/D33232


# 6d33315d 30-Jun-2020 Mateusz Piotrowski <0mp@FreeBSD.org>

Cross-reference style(9) and style.mdoc(5)

Suggested by: yuripv
MFC after: 3 days


# ca588aed 10-Mar-2019 Mateusz Piotrowski <0mp@FreeBSD.org>

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


# 6e33d37f 24-Feb-2019 Mateusz Piotrowski <0mp@FreeBSD.org>

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


# e84f6455 29-Dec-2018 Mateusz Piotrowski <0mp@FreeBSD.org>

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


# 13bf4d9e 28-Dec-2018 Mateusz Piotrowski <0mp@FreeBSD.org>

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