From nobody Fri May 10 21:08:52 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 4VbhM90szBz5KRDP; Fri, 10 May 2024 21:08: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 4VbhM90NXlz4bTM; Fri, 10 May 2024 21:08:53 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1715375333; 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=8hcy2gdcp6C4epJriRU75YIUQGo4p/gQaTu6LrZZ6EA=; b=kyXOf2dYPxtCwLnmaFf71wewoFvgogizH1K+ASgnaclyHQlNpA8JuneSnhxWWEQt6ZuYtD 7kfUgK8NRcSDyCHjYmwmyGB3LGBVwfw7eMq0oLHs6KhoHZYSQEDMoGCHkpOIcXSTVYAzv8 IqJPZgI4yfa3W0oVSDWadZBty6++sAB5RicsZ4amsqpG3CyU5xhnJG9vCKDQhotEZRwcJn DK1J/SCUOYZqkcXIiGiduGwER4xTJaEdaq45h/17QyK4zrS0QcQQHiUViLmBF+1Or0ZsKW IY/9I1uXuzqhfgtPSwkwbw4v3o4XaG7SkoVNWb3I8ze50aZyh12RzwiopVdxnQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1715375333; a=rsa-sha256; cv=none; b=RmDTvCvNwQ3ubnPPJ1eXwzWd6rVfQ3UBnq0WpFPZMbkb/uzEzmlete5+QBnaqr3TzBP5ZZ VAqO26mzEMvfjLf7b6BU2Ub8JCF9Z77mKjNx62L80TGa90b+IAUM2y5FsnGYm9AK+rGZyU OQtgGGrdH0n5qOI+QHFTaE2CMg/4ALNM4biXj438fiADHjjVDWl3wtlZcCEGEv0cOUmccw lZ6pTNTsScfn4+0KNa2Rnec/+yq/lTbwQqfs6Axh9rjFEu0vFD8fXIItGgnkQVaexovayh w/W3FosEpj8zng59/LC3upk77A5CtEkAUWt3daVJi/+oBuXV55yx9lLfuwnFXw== 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=1715375333; 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=8hcy2gdcp6C4epJriRU75YIUQGo4p/gQaTu6LrZZ6EA=; b=xEVFYMUSCWMIWmji6BsdY+cqSQwZ18clDc2BMsAt/JjPMm0s4bQOkmyUM88ZtCssS+Ky20 7Vr6X5VsctEbkp0AnchOawTW2shucJbEjyhhG1gO+qGN/WTK7r5dXYjsKvf5dZz6vgYmux WYJ3X9oOnZngoTrlWQ+GuC2cj5Ajasjr+12HNfAmWFi5Y2sMfn/v5AnkX02XmI2QJeY1mt hBqRBXVH4aDVwRzauiQY/hfE/K1SacwqcWNiG2goo6YYU4qGt9zPPzZQ8q5unHGbdz9UrY Sz2mSJ32ZI+dxh9XjLSGPsfecAYqwIMSgryTaM5m+p2yvw3U1a3LA3awqhFODg== 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 4VbhM86z9LzsY3; Fri, 10 May 2024 21:08:52 +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 44AL8qPG066337; Fri, 10 May 2024 21:08:52 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44AL8qos066334; Fri, 10 May 2024 21:08:52 GMT (envelope-from git) Date: Fri, 10 May 2024 21:08:52 GMT Message-Id: <202405102108.44AL8qos066334@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: 467e3e2f2052 - main - CONTRIBUTING.md/style: spring cleaning 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 Sender: owner-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: 467e3e2f2052faa012e6100915b6f99a0c74bfb9 Auto-Submitted: auto-generated The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=467e3e2f2052faa012e6100915b6f99a0c74bfb9 commit 467e3e2f2052faa012e6100915b6f99a0c74bfb9 Author: Alexander Ziaee AuthorDate: 2024-05-10 06:07:59 +0000 Commit: Warner Losh CommitDate: 2024-05-10 21:07:03 +0000 CONTRIBUTING.md/style: spring cleaning + move Lua to alphabetize subsections + word manpages like other subsections + man PR's shouldn't bump document date MFC after: (maybe MFC to BETA3 along w/ e7ff917057ea ?) --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c26b1d335c5f..8e79652a09d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,19 +106,21 @@ command can help minimize churn by only formatting the areas nearby the changes. not perfect, using these tools will maximize your chances of not having style comments on your pull requests. +For [Lua](https://www.lua.org), see +[style.lua(9)](https://man.freebsd.org/cgi/man.cgi?query=style.lua&sektion=9) +for details. Lua is used for the boot loader and a few scripts in the base system. + For Makefiles changes, see [style.Makefile(5)](https://man.freebsd.org/cgi/man.cgi?query=style.Makefile&sektion=5) for details. FreeBSD's base system uses the in-tree make, not GNU Make, so [make(1)](https://man.freebsd.org/cgi/man.cgi?query=make&sektion=1) is another useful resource. -The project uses mdoc for all its man pages. Changes should pass `mandoc -Tlint` and igor (install the latter with `pkg install igor`). -Please be sure to observe the one-sentence-per-line rule so manual pages properly render. Any semantic changes to the manual pages should bump the date. -[style.mdoc(5)](https://man.freebsd.org/cgi/man.cgi?query=style.mdoc&sektion=5) has the all details. - -For [Lua](https://www.lua.org), please see -[style.lua(9)](https://man.freebsd.org/cgi/man.cgi?query=style.lua&sektion=9) -for details. Lua is used for the boot loader and a few scripts in the base system. +For manual page changes, see +[style.mdoc(5)](https://man.freebsd.org/cgi/man.cgi?query=style.mdoc&sektion=5) +for details. Changes should pass `mandoc -Tlint` and igor (install the latter with `pkg install igor`). +Please be sure to observe the one-sentence-per-line rule so manual pages properly render. +Proposed changes to manual pages should not bump the document date until merged. For shell scripts, avoid using bash. The system shell (/bin/sh) is preferred. Shell scripts in the base system cannot use bash or bash extensions