From nobody Fri Apr 12 22:31:49 2024 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 4VGWWn6mLSz5GGg8; Fri, 12 Apr 2024 22:31:49 +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 4VGWWn6K2qz4rK2; Fri, 12 Apr 2024 22:31:49 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712961109; 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=HVvU8j0uGTadEnLdDELDMEsFhllTIBf3UhafraGZ8jU=; b=RD4iZtMPj/d3bES6ZUGA6S2qB10z8ZM7FxBZ1m+DUn6c36tAxRaH4+lgZeIdt/FzHtbhRy vDYu2zZ30Ds/yU6RrMDI82qR5ooSL8bL0X4KKsGG1vWT+CQ0THaZGWvKzT4R3WigvW82Ue gK4jFaqoUNOL9XfZBeQWSn/R31P90ciM10gCWgesW7TJ/qUU05pRGwPVVqW0eSDsJlwj9v TqLhKQ80wP/xr4+b+1qLaTG2L8dQ+89B5Z7OriMWUD+pXVgRo7lpnsbh46lJpo93ANcDd/ vYG2ZF2JTVqLLU65dahhEBGe+k1QbXemDdi0SdwDqBVZQ/b0YPFqmPunBAW1JQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1712961109; a=rsa-sha256; cv=none; b=WdZJis0YsDtr/g3ccFjg1Jj2SL76FGySH77JXQWt9qoMjruxD726SRxP65icuKQXuU04LM hH4A/1scvYO3OSoDAiRNBIFCkpgD7jzA8FvQBlvPcLfNnvZuJks9uNvCm4w3OEZ2ackPMg DSUYSzQiuI9f1JiJTg77GaQOcQ6HPNrKDYCaTVScw9bmbzenoGZGmRYwz87+RammhDqh25 gVND2ne3HvTrtJZjr7D1JfXrPUdlPXVlYSQTOq5yrGC7qAdEtvxBZZPQ2m1ZgJQI3Wgmdg eYbzSXVakk6qX9SRYAL+GciJ1kAzAeyN/wZ2s++OVvuLmMyteKb/h7wYUN2lJQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712961109; 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=HVvU8j0uGTadEnLdDELDMEsFhllTIBf3UhafraGZ8jU=; b=bcaxy0L9wIOvCUijZOw344z26h6utxtdDc9ZDsl2kQMqkdtkETImLV8k9h2oqGPZuuvfXy 7L/7lK1HZHEKFKcDxWZjvgFdMUC8/Qd8swrTHl4lPtQziZ41O+IMA97uA4p8OKdBPbnwAR H4DLqbglcfemzD/rM2JLAQAVtYUi/ZCHm29/tL+FPUYNmPjcqFVeV8BXeF85J+PQJujNzr 8yOrqDqjNBezRZ6X8saJHfHn1wlv2yClhAJOcOKBI/fyTr4wY4psrLXXBFPymCTktyg0HG nNw52uyf5rntcy0MkNBOYB3ar2KDwQyjras+Yo3TcgY3Ptd7nPuf98cvfZUm9A== 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 4VGWWn5w4Hz16s4; Fri, 12 Apr 2024 22:31:49 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 43CMVnlX016291; Fri, 12 Apr 2024 22:31:49 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 43CMVnsr016288; Fri, 12 Apr 2024 22:31:49 GMT (envelope-from git) Date: Fri, 12 Apr 2024 22:31:49 GMT Message-Id: <202404122231.43CMVnsr016288@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: e7ff917057ea - main - style.mdoc.5: maintenence 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: 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: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e7ff917057eaf209c003660f02decb64ccb811da Auto-Submitted: auto-generated The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=e7ff917057eaf209c003660f02decb64ccb811da commit e7ff917057eaf209c003660f02decb64ccb811da Author: Alexander Ziaee AuthorDate: 2024-04-12 22:28:12 +0000 Commit: Warner Losh CommitDate: 2024-04-12 22:29:25 +0000 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 --- share/man/man5/style.mdoc.5 | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index c1592bf8b87f..42dbc940074c 100644 --- a/share/man/man5/style.mdoc.5 +++ b/share/man/man5/style.mdoc.5 @@ -1,4 +1,4 @@ -.\" +.\"- .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org> @@ -24,7 +24,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd January 29, 2022 +.Dd April 12, 2024 .Dt STYLE.MDOC 5 .Os .Sh NAME @@ -32,7 +32,7 @@ .Nd .Fx .Xr mdoc 7 -file style guide +manual page style guide .Sh DESCRIPTION This file specifies the preferred style for manual pages in the .Fx @@ -82,17 +82,17 @@ Format the section in the following way: .Bd -literal -offset indent \&.Bl -tag -width 0n -\&.It Sy Example 1\\&: No Doing Something +\&.It Sy Example 1\\&: Doing Something \&.Pp The following command does something. \&.Bd -literal -offset 2n -\&.Li # Ic make -VLEGAL +\&.Ic # make -VLEGAL \&.Ed -\&.It Sy Example 2\\&: No Doing Something Different +\&.It Sy Example 2\\&: Doing Something Different \&.Pp The following command does something different. \&.Bd -literal -offset 2n -\&.Li # Ic bectl list +\&.Ic # bectl list \&.Ed \&.Pp It is good to know this command. @@ -100,24 +100,22 @@ It is good to know this command. .Ed .Pp which renders as: -.Bd -filled -offset indent .Bl -tag -width 0n -.It Sy Example 1\&: No Doing Something +.It Sy Example 1\&: Doing Something .Pp The following command does something. .Bd -literal -offset 2n -.Li # Ic make -VLEGAL +.Ic # make -VLEGAL .Ed -.It Sy Example 2\&: No Doing Something Different +.It Sy Example 2\&: Doing Something Different .Pp The following command does something different. .Bd -literal -offset 2n -.Li # Ic bectl list +.Ic # bectl list .Ed .Pp It is good to know this command. .El -.Ed .El .Ss Lists .Bl -dash -width "" @@ -285,6 +283,7 @@ that would be rendered as: .Xr man 1 , .Xr mandoc 1 , .Xr mdoc 7 , +.Xr roff 7 , .Xr style 9 .Sh HISTORY This manual page first appeared in