From nobody Fri Dec 10 22:16:16 2021 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4C8F618DEAA1; Fri, 10 Dec 2021 22:16:17 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4J9lc06lHTz3Dy1; Fri, 10 Dec 2021 22:16:16 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id C8DC1222E7; Fri, 10 Dec 2021 22:16:16 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 1BAMGGS4044543; Fri, 10 Dec 2021 22:16:16 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 1BAMGGDi044542; Fri, 10 Dec 2021 22:16:16 GMT (envelope-from git) Date: Fri, 10 Dec 2021 22:16:16 GMT Message-Id: <202112102216.1BAMGGDi044542@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 8316f0904607 - stable/13 - style.mdoc: Prefer Ql to Dq Li for literal display List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 8316f0904607818f4ea427723234d1a302196f7a Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1639174577; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=72BJmiUHZuZTQGDjFB+NH7ueoGo67aw9YAidhU/ufd4=; b=RNQXFZNI0Tnu2sn0zBpQkfrzqcxWOn+GOeIjNqa7qirUA/GTJb5oJOrVim6nsvXTVNPerA gjd/kGCd1kJSCJgJcmzOb3bWpia3WiDfAC8gdWY0nVcq6WjR4x/DWxWkn9f1YNeOaKmqUF aJT1WjGOqSMCxNQ8JdnYWTX50p+6absUgi0jd0lB3UoiIb4cM5BDS08Q7bnnZPvWVnwbJP SUFFJZZato4ny52EUSzJPUsp1xQmtMzRQupBDJvmo79tcK5BwPERvJhk93HJaMov7Dc+g8 TaGCJ1PS2cNe8JZ0i2hVgwhaB2kGKI9IlP8N2KA6wUgJ+uIVqVAMRGhxYPT3bQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1639174577; a=rsa-sha256; cv=none; b=NyryrkCcScu9O6cL0woRlW6lj4dUuoZuSLvN3Y8A+fBHmSdI3bhw/tB2effoaJ2r3nYWgw Cp6OHYBR4bZy/1VkAv1SX40muwuriencQHB1kGG8HnJqWGBdgzsY0EtVH13kXsrZIuU2lK 2eLQqSs0yeI+mjfxtptO2sPy9IudxleiJkvodZV1FTfj+M5rh5ZbUiGu8/UFoUS9Fk129D 9/uWYKB403KWS2/mVrDeBWpRw+Avv2boiO5ZEFscEkp4ZCsHvsrv/TlRc3qnlWdNj2OpSE iH54ruBgPFBZijMa+N5E1C+IeyjYhDzzAyBEJo5mbQJ80oh53b0zbIYTAkSh7g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N 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 ""