From nobody Sat Jan 29 21:24:53 2022 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 AE08F1974050; Sat, 29 Jan 2022 21:24:53 +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 4JmS5d4F02z4cJ6; Sat, 29 Jan 2022 21:24:53 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1643491493; 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=jzRLZGcK0BimakgrFiQDKk0MHic2ey5J7lcAjY6+o8M=; b=KHB9On0QgEPjigIsRxjTNhWwiLQh5aQs3ATN1KHMPfQy6In4Gf38Nm+40ExuSS6yfpnI4N PQr6vkwjISdO+qC1FfdiAhUFaCM+3q30mV4khDFC2iUtNkwR9+Gzsma0K+gg5j6WpsJA3w x2U1SzBItCd9uulBNhnnPUbTYulIxU6cszJocBHAq85lB/VNPYpyMXRYgBZYuEsser4A+I +ajBsviiNHfQWW2YfaanlahqtwCHC2XqR+CnsTHSFJBcsvR6OLdTHcv2q8ORQeRJWxBN3s XxBBZnfxWpp52xhK9IVQQbmfUGiuOwQskunXWzNehguUxeTluLCZYl/YMuI/vw== 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 713C11CC42; Sat, 29 Jan 2022 21:24:53 +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 20TLOrHe060471; Sat, 29 Jan 2022 21:24:53 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 20TLOrZZ060470; Sat, 29 Jan 2022 21:24:53 GMT (envelope-from git) Date: Sat, 29 Jan 2022 21:24:53 GMT Message-Id: <202201292124.20TLOrZZ060470@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 79afae3b3f24 - main - style.mdoc.5: Document the conventions for -width 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/main X-Git-Reftype: branch X-Git-Commit: 79afae3b3f245ffa79726ae097cc843628ae9d92 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1643491493; 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=jzRLZGcK0BimakgrFiQDKk0MHic2ey5J7lcAjY6+o8M=; b=Nxf/Y8bSLHKyOVEM321jbi0uGhOdzzSFUUrxkCEWnIlUrF87UEx7inmJLUZNF6/m1XlE23 pBfYoqbKC6eGdwSaouraWOETDY1nxzLhICT2BJNSIlszu+vQxeurVdXF5Nur7obocoSJHc ygIxopH4aPPuti1nbweb1kqCZsflcPCbT9nYAdvkBNQD17IRd52RI3Z8W6q+cerVVogAGy dcTcW1DLxo+zuocvGZrX6Y59lT1i6qnzLfyuKQU/uPaRsnMGgowMcy6UVKkcgHicT2O2hv u5cojY4N9HpnQ7Hmw8ilw/aeTMNccj9Vemr517HIpqPu2tYDUlPb7exNxM8Vbg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1643491493; a=rsa-sha256; cv=none; b=mu9m+10WfhC39/YsdjjsWHNNX58GbHFEJ3i9EqSe84UOh73Z/b5dSv/JXB279Sdkd2gKu5 dL8I5ESTnEC7FYsAn3l17UsFtRVkH8dGBtGKHpRPSc/uBX8F2JP28VC9hNTAPL6pqwQckZ bpd0HgVGpfOGrn7WBGqI9SqEpgE3q0V0pyc/Qm+PGnIG9xMUCGMuP0RooxAQOZ48dt4269 mgDopfbHQyonlFl1h/0QG9Ud7OkO6JjCN7oUZfl5L4IsLTbitZ7qzxccdvQQi8a0Qxwrnu 3Y52hpr87RCnQYrMqvKgtbHPyFwuDGv+U9Y48+B2jAbbQs3NaQRbz2ySW0DEFw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=79afae3b3f245ffa79726ae097cc843628ae9d92 commit 79afae3b3f245ffa79726ae097cc843628ae9d92 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-01-29 21:23:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-01-29 21:24:35 +0000 style.mdoc.5: Document the conventions for -width Reviewed by: debdrup MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D33394 --- share/man/man5/style.mdoc.5 | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index f8ad4fb4029b..81f10b9df845 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-2021 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" Copyright (c) 2018-2022 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 December 3, 2021 +.Dd January 29, 2022 .Dt STYLE.MDOC 5 .Os .Sh NAME @@ -121,6 +121,42 @@ It is good to know this command. .El .Ed .El +.Ss Lists +.Bl -dash -width "" +.It +The +.Fl width +argument to the +.Sy \&.Bl +macro should match the length of the longest item in the list, e.g.: +.Bd -literal -offset indent +\&.Bl -tag -width "-a address" +\&.It Fl a Ar address +Set the address. +\&.It Fl v +Print the version. +\&.El +.Ed +.Pp +In case the longest item is too long and hurts readability, +the recommendation is to set +the +.Fl width +argument +to +.Ql indent , +e.g.: +.Bd -literal -offset indent +\&.Bl -tag -width "indent" +\&.It Cm build +Build the port. +\&.It Cm install +Install the port. +\&.It Fl install-missing-packages +Install the missing packages. +\&.El +.Ed +.El .Ss Synopsis Formatting .Bl -dash -width "" .It