Date: Fri, 10 Dec 2021 22:16:16 GMT From: Mateusz Piotrowski <0mp@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Subject: git: 8316f0904607 - stable/13 - style.mdoc: Prefer Ql to Dq Li for literal display Message-ID: <202112102216.1BAMGGDi044542@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=8316f0904607818f4ea427723234d1a302196f7a commit 8316f0904607818f4ea427723234d1a302196f7a Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2021-12-02 11:39:45 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2021-12-10 22:16:08 +0000 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 (cherry picked from commit 5e077e08ef87126765b5a818def6cb99314ab192) --- share/man/man5/style.mdoc.5 | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index 368b6565b496..f8ad4fb4029b 100644 --- a/share/man/man5/style.mdoc.5 +++ b/share/man/man5/style.mdoc.5 @@ -1,7 +1,7 @@ .\" .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD .\" -.\" Copyright (c) 2018-2019 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" Copyright (c) 2018-2021 Mateusz Piotrowski <0mp@FreeBSD.org> .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 30, 2020 +.Dd December 3, 2021 .Dt STYLE.MDOC 5 .Os .Sh NAME @@ -45,13 +45,13 @@ source tree. Use literal formatting for examples and literal shell commands, e.g.: .Bd -literal -offset indent Then run -\&.Dq Li make install clean . +\&.Ql make install clean . .Ed .Pp which renders as: .Bd -filled -offset indent Then run -.Dq Li make install clean . +.Ql make install clean . .Ed .Pp The incorrect way would be to use macros like @@ -59,14 +59,22 @@ The incorrect way would be to use macros like to stylize the command invocation: .Bd -literal -offset indent Then run -\&.Dq Nm make Cm install Cm clean . +\&.Ql Nm make Cm install Cm clean . .Ed .Pp which renders as: .Bd -filled -offset indent Then run -.Dq Nm make Cm install Cm clean . +.Ql Nm make Cm install Cm clean . .Ed +.It +The +.Sy \&Ql +macro is the preferred macro for formatting literal inline fragments. +Historically, +.Sy \&Dq \&Li +was the preferred way before the deprecation of +.Sy \&Li . .El .Ss EXAMPLES Section .Bl -dash -width ""
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202112102216.1BAMGGDi044542>