From nobody Thu Feb 27 01:13:58 2025 X-Original-To: dev-commits-src-branches@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 4Z3CzB5zXVz5pMtj; Thu, 27 Feb 2025 01:13:58 +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 "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z3CzB2X3zz3vlM; Thu, 27 Feb 2025 01:13:58 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740618838; 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=/ZnVG3+val+8UZOnCZMiHqO2QKq9AMFBvh6Y3pJqEmc=; b=e5ZReXXf/mhXnzyJ3yCvhQxNxXcCurxdg8p0/Ar8xZmrLVtrEk1GeIdvzYS8xULwT5uRtQ Tn/Oc3g9tCmnlIzW5zYsz8XdhMlaOYg9db3A7yL14+F3wEvcDZR1pVHqgGQhpnYmBqZLUB 08MVKWwd37+wW51mCIAF6XITQJHYaiOrnaPgheeLZ+Uq2VztCIGoiwfbYReswc7cGbLAi7 YC2VFxFNIgeGbpApWg6fpFDikcE6hScUeCC/5eO3luu6b5COC+LHtIKMCN+qtItEBohvD2 2dsm/tOLpd589R00sXA/yQLN4G8ZEBk7IVTrW5aWosMisI1L88ENv9fSbUM7jg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1740618838; a=rsa-sha256; cv=none; b=vhke5NeCT0aL9AvcXC03JgsLk3aZtU8zQ68xWxm399KmBI8R3GMUkNlVfutFAl1MdFJhWy 3ukFCtO3v6T8hdAmOjn/8dljI2a/e6IzQen1J2zuM8lO3b1sPB33iyjht1xCC49DFNye7d cnpW30bZNj59q905bedixNeFSAsMIaRgzMuUwTOTmx1WGXB4OIouX+IxR6Ij0C+xhX5aTE faZNhQdWqm9k+h6pPl5L7RsCOTkQGf8oMBLPc4NTNi69l/bVm/X032d8n7q5AClqgZks+/ zkST5G+VPhD82MgDLOhSSsDC2rPuetpbhGW2EDfESoVBd9jkYcAJumMLp0shfA== 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=1740618838; 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=/ZnVG3+val+8UZOnCZMiHqO2QKq9AMFBvh6Y3pJqEmc=; b=GRz1eDaHseIohmqSNlpHDI3o4MtPTDiUcq0pj58SgA9gXwT+fWtxO8/g02o4Aou5JQUQHe 9+2mUpvaLs/9nIw+DzGSKDWo2PlozDkfvUA3DrAnjJ/Jx3wR+ruEFy6FYaefW+iHb8dQK7 DEFadc4AL/hvl5GVI1CugJXxonAym6mA4xqxQkei0j5mlCtD2vjRv5GzdfX6tn18KeUG15 zq1rduyGPk+naS3DGRwhWq2VKLr3FLlNpBTEly4JJh4HuhSmOgVIc4HDumv2DdR+P9qyB/ rlXuukGNwaf9VYfNTuB9sY9JMTLkQTBQTpNNGgerg3cvWj/xOZw+ca1OrO3Xig== 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 4Z3CzB1Wzlz5YP; Thu, 27 Feb 2025 01:13:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 51R1Dwe7054747; Thu, 27 Feb 2025 01:13:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 51R1Dwlf054744; Thu, 27 Feb 2025 01:13:58 GMT (envelope-from git) Date: Thu, 27 Feb 2025 01:13:58 GMT Message-Id: <202502270113.51R1Dwlf054744@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Alexander Ziaee Subject: git: 3b210577b85a - stable/14 - style.mdoc.5: maintenence List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: 3b210577b85a6dee3d5fa0bd4ac48b45bcf6ce23 Auto-Submitted: auto-generated The branch stable/14 has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=3b210577b85a6dee3d5fa0bd4ac48b45bcf6ce23 commit 3b210577b85a6dee3d5fa0bd4ac48b45bcf6ce23 Author: Alexander Ziaee AuthorDate: 2024-04-12 22:28:12 +0000 Commit: Alexander Ziaee CommitDate: 2025-02-27 01:13:30 +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 (cherry picked from commit e7ff917057eaf209c003660f02decb64ccb811da) --- 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