From nobody Thu Jul 31 15:07:47 2025 X-Original-To: dev-commits-doc-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 4btCBC5Vgmz63xGW for ; Thu, 31 Jul 2025 15:07:47 +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 4btCBC4ZYDz3Kdj; Thu, 31 Jul 2025 15:07:47 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1753974467; 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=Ys9oLUJ05oP5sY8QPTIGyRMy3L+PQdi8Z/jxC9WFA78=; b=a136V4sw7mKMDEFbjZ2VYaU0/X1QQRfi4xTRbV/s/MqAYYkcvTsZmHbJHNLcL8KKMa2ghi Wo1kGlr3HekWh4/tH2zfkZRyamSITh0/CLvHaoFiQKAORo+MpKu57oF4wynsQvJ6mJ7hkE hKsn3aGP1GxcRb4JwWPuhuqj0Ru22ngGvl5gitxXXa2zCYXPzBtdkGaQ02dOjj7P9/HJyF pjxHRPBwQ/sFSkeZ9OZMYCmK0+BhrFcopdeTshTwKyTKJOW+9kJi9RkpLuky028XoHzq5A LWNJgPVskj8MtzUHVlXeoBKSNyT+DGawAJOTQptjrdu0A1BQRJqFI43mEg1SDw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1753974467; 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=Ys9oLUJ05oP5sY8QPTIGyRMy3L+PQdi8Z/jxC9WFA78=; b=WlfZykVR9s2SrBeN9nzShRif0bUqtfU/m9mt6xIzFAwzxC76dAo7rZLaXIGbA6Wb1FnfCm 72MopJIjnem5iHVL0rmqWv5R4ItDzF0LuKo+XF8Rt9MU1IE0fxr1pRx+2qQMP7zgLiAU2L f2dHPmIx2FMTOAJ6rGT+6xlwcmEr8m+sKn0wKXusGGGZ2HAc1uiy8ScbDWXdvct04NlRd0 f1JmsMhYz8//Wh638GMeXlf8BeUfPCAWsLhTQMUdsp/6urwaj0o78HnC96laU/MhTS1Dux qX+sBk8V23qwxHcHFc+ieG76JZ1vZciSAgyCV38f4gMk1AUyWc59uNMJJGpCrw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1753974467; a=rsa-sha256; cv=none; b=fq8CQYd/JhLCa9LmXO3Qa9VY9KCoLbF1sOb3SyNxc6f028riNu+6IGGP/tHDYX5LlSFtDd RZ8W34VR9RyZSs+wbL+270LFCIGPv9r52pQF+6+PEyrzzoqWKSdcl6GbUBz2Q5HvshKGAc We1heskDqNL45Bnenhs4QanKaPr3vVIHYdyMRXFNqqvBJ101XU07TY2YgusgrhojIdpbQ+ l9wBj4T8BXcT3dCjNvoq9B+CI9n7CzFrK2+xtXrWK2irkxyaIrN0PdknSrmZ+QDAzrRrnW T8R7VA7gRr1HJqZPOlvExG5MWdkPsj8Rw2GPEomg4ODKNZMhZmMXOxHC6QuOzQ== 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 4btCBC484xz16GN; Thu, 31 Jul 2025 15:07:47 +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 56VF7lDo032592; Thu, 31 Jul 2025 15:07:47 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 56VF7l0q032589; Thu, 31 Jul 2025 15:07:47 GMT (envelope-from git) Date: Thu, 31 Jul 2025 15:07:47 GMT Message-Id: <202507311507.56VF7l0q032589@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ed Maste Subject: git: ba39086dd2 - main - committers-guide: Increase subject length limit to 67 characters List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: emaste X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ba39086dd26235d09c710c91f31a5da45096f430 Auto-Submitted: auto-generated The branch main has been updated by emaste: URL: https://cgit.FreeBSD.org/doc/commit/?id=ba39086dd26235d09c710c91f31a5da45096f430 commit ba39086dd26235d09c710c91f31a5da45096f430 Author: Ed Maste AuthorDate: 2024-11-11 17:41:33 +0000 Commit: Ed Maste CommitDate: 2025-07-31 15:06:17 +0000 committers-guide: Increase subject length limit to 67 characters I originally suggested a 63-character limit "so that git log --oneline avoids wrapping." Short hashes in the tree are typically 12 characters, and a space between the hash and the subject should result in a limit of 67 characters. I think I arrived at 63 by subtracting git's typical 4-space indentation from 67, but that indent is not applicable to `git log --oneline`. Reviewed by: olce Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48246 --- documentation/content/en/articles/committers-guide/_index.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index dc3e6a4679..0b23426894 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2480,7 +2480,7 @@ The subject should, by itself, allow the reader to quickly determine if the chan The subject line should be as short as possible while still retaining the required information. This is to make browsing Git log more efficient, and so that git log --oneline can display the short hash and subject on a single 80-column line. -A good rule of thumb is to stay below 63 characters, and aim for about 50 or fewer if possible. +A good rule of thumb is to stay below 67 characters, and aim for about 50 or fewer if possible. === Prefix the subject line with a component, if applicable @@ -2489,7 +2489,7 @@ If applicable, try to use the same prefix used in previous commits to the same f ✓ `foo: Add -k option to keep temporary data` -Include the prefix in the 63-character limit suggested above, so that `git log --oneline` avoids wrapping. +Include the prefix in the 67-character limit suggested above, so that `git log --oneline` avoids wrapping. === Capitalize the first letter of the subject