From nobody Sun Jul 12 09:03:43 2026 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 4gyfkS0tL1z6l5cV for ; Sun, 12 Jul 2026 09:03:44 +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 "YR1" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4gyfkR73Mpz3HvV for ; Sun, 12 Jul 2026 09:03:43 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1783847024; 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=ifgdodNockkB9hlCS1F9XSGAAuwvBh1/dwQm/7qrEqk=; b=tf6USb0Jo2zsY9iKGgDrnQ1q8jh4g4uAlmFCEots1J9L61K8RXhsuTTCz21R+is5pSg1KJ JNA2cKm14TQvzKato/eWBfUzPDsikJqE1kaFeVILEFINihWzrsP8LTVW+F1AEyp1hlws6Z fwWO6S/Z7FxEyCCeSJODKrSVXdxZV2xyuiESonEamCSQKSRpqvVxe9cqlArN9qegIvvkDQ WrdZr9PvcH567m8maKGwWOD9ZCZ+oK+1hMHnOWaEBW/S2RR8EYdunNx1Vd/fVBIO+VVKQw eHNDigkbSSOC8EEr5HIIPryZ52lnkBGix7hwU9i+xHEX/r7pR3PeDwi/RGlhNg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1783847024; a=rsa-sha256; cv=none; b=uchMv5bYXwCE30GLxyLRPWEGTrIht4/kXFS9u8QfNWOE4IgMS/aqgh0v9juorTMkh3L14y fyaPMtTcXHPvHOVk8KaIsAjZYZxXEEPWigS5ZvDmVWqYdNNx2jXHPyzvevJ/XKYWX/nWN0 qkuBzrrjwTkVJG2OjedyH69FHyxGVNJQz26r+YWbE9EbnexmkL6HSYK0gZuAdqMmzHzcBG gHq2SgxQ8Rbp5MFhafEGluGEye+cyPniww44cl1+089F6PADOmkFdzTtKoHRD8EmfOgVsD VE+yXKZUAymrGw8oli7iqe8p3SYcy8m+ge2b2to1lc6PWRLAHLSZRowCqAkgpQ== 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=1783847024; 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=ifgdodNockkB9hlCS1F9XSGAAuwvBh1/dwQm/7qrEqk=; b=FHED4dDZ9DtvB5VYhl+vaBd9gpKBQ30QklHcI2wZ+34nZhnh7L2hxhgEJrz2r57VRRehek yZwYG0R/ysJPGsE6oFRQXS/gbbuDLQzJOaqtqpwQSD1tpVcJxVDQiEDXm+r9pPO14nCM5i ZcG3c0A6YyptFqrmHrboulrXZzjC2Cli6otzw0BRZIfBhCju3M6MY3VEeuvxVWz7nD24/7 c+PW3hMlGnryr0WTmX+HEERfpNY0MuxOPouugzlAvR8G6Ogg/Bno16M/ZvcFvA7U+Y+3Gq JQWcRBnE/eJ4LxFJ7Rd4THz89MOTTilwBbDn9idFpcT6lDUy8/49hxyt+7Whfw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4gyfkR5vHHz1Kdg for ; Sun, 12 Jul 2026 09:03:43 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 3698c by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Sun, 12 Jul 2026 09:03:43 +0000 To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Alexander Ziaee Subject: git: 19222efd85 - main - committers-guide: Use macros for branch examples 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 List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 19222efd8599079e6b3f3a39cfc3ddec3f687c24 Auto-Submitted: auto-generated Date: Sun, 12 Jul 2026 09:03:43 +0000 Message-Id: <6a53586f.3698c.2b83986c@gitrepo.freebsd.org> The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/doc/commit/?id=19222efd8599079e6b3f3a39cfc3ddec3f687c24 commit 19222efd8599079e6b3f3a39cfc3ddec3f687c24 Author: Alexander Ziaee AuthorDate: 2026-07-12 09:02:50 +0000 Commit: Alexander Ziaee CommitDate: 2026-07-12 09:03:03 +0000 committers-guide: Use macros for branch examples PR: 279503 Reviewed by: wosch Differential Revision: https://reviews.freebsd.org/D57937 --- .../en/articles/committers-guide/_index.adoc | 38 +++++++++++----------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 45350e0ba2..b974f62b70 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -456,9 +456,9 @@ FreeBSD-CURRENT uses the `main` branch. `main` is the default branch. -For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`. +For FreeBSD-STABLE, branch names include `stable/{rel-latest-major}` and `stable/{rel-legacy-major}`. -For FreeBSD-RELEASE, release engineering branch names include `releng/12.4` and `releng/13.2`. +For FreeBSD-RELEASE, release engineering branch names include `releng/{rel-latest}` and `releng/{rel-legacy}`. https://www.freebsd.org/releng/[] shows: @@ -467,8 +467,8 @@ https://www.freebsd.org/releng/[] shows: Examples: -* tag https://cgit.freebsd.org/src/tag/?h=release/13.1.0[release/13.1.0] on the https://cgit.freebsd.org/src/log/?h=releng/13.1[releng/13.1] branch -* tag https://cgit.freebsd.org/src/tag/?h=release/13.2.0[release/13.2.0] on the https://cgit.freebsd.org/src/log/?h=releng/13.2[releng/13.2] branch. +* tag https://cgit.freebsd.org/src/tag/?h=release/{rel-latest}.0[release/{rel-latest}.0] on the https://cgit.freebsd.org/src/log/?h=releng/{rel-latest}[releng/{rel-latest}] branch +* tag https://cgit.freebsd.org/src/tag/?h=release/{rel-legacy}.0[release/{rel-legacy}.0] on the https://cgit.freebsd.org/src/log/?h=releng/{rel-legacy}[releng/{rel-legacy}] branch. ===== Repositories Please see the crossref:committers-guide[admin,Administrative Details] for the latest information on where to get FreeBSD sources. @@ -876,7 +876,7 @@ For more on this topic, https://www.freecodecamp.org/news/the-ultimate-guide-to- It is a good resource for issues that arise occasionally but are too obscure for this guide. ===== Switching to a Different FreeBSD Branch -If you wish to shift from stable/12 to the current branch. +If you wish to shift from stable/{rel-latest-major} to the current branch. If you have a deep clone, the following will suffice: [source,shell] .... @@ -886,18 +886,18 @@ If you have a deep clone, the following will suffice: If you have a local branch, though, there are one or two caveats. First, rebase will rewrite history, so you will likely want to do something to save it. Second, jumping branches tends to cause more conflicts. -If we pretend the example above was relative to stable/12, then to move to `main`, I'd suggest the following: -[source,shell] +If we pretend the example above was relative to stable/{rel-latest-major}, then to move to `main`, I'd suggest the following: +[source,shell,subs=attributes] .... % git checkout no-color-ls -% git checkout -b no-color-ls-stable-12 # create another name for this branch -% git rebase -i stable/12 no-color-ls --onto main +% git checkout -b no-color-ls-stable-{rel-latest-major} # create another name for this branch +% git rebase -i stable/{rel-latest-major} no-color-ls --onto main .... What the above does is checkout no-color-ls. -Then create a new name for it (no-color-ls-stable-12) in case you need to get back to it. +Then create a new name for it (`no-color-ls-stable-{rel-latest-major}`) in case you need to get back to it. Then you rebase onto the `main` branch. -This will find all the commits to the current no-color-ls branch (back to where it meets up with the stable/12 branch) and then it will +This will find all the commits to the current no-color-ls branch (back to where it meets up with the stable/{rel-latest-major} branch) and then it will replay them onto the `main` branch creating a new no-color-ls branch there (which is why I had you create a place holder name). [[mfc-with-git]] @@ -909,18 +909,18 @@ For multiple commits, use `git rebase -i` to squash them together and edit the c ==== Single commit MFC -[source,shell] +[source,shell,subs=attributes] .... -% git checkout stable/X +% git checkout stable/{rel-latest-major} % git cherry-pick -x $HASH --edit .... For MFC commits, for example a vendor import, you would need to specify one parent for cherry-pick purposes. Normally, that would be the "first parent" of the branch you are cherry-picking from, so: -[source,shell] +[source,shell,subs=attributes] .... -% git checkout stable/X +% git checkout stable/{rel-latest-major} % git cherry-pick -x $HASH -m 1 --edit .... @@ -939,9 +939,9 @@ The process is the same for either a typical merge or an exceptional direct comm * Leave both "cherry picked from" lines in the commit message. * Be sure to add the `Approved by:` line when you are in the editor. -[source,shell] +[source,shell,subs=attributes] .... -% git checkout releng/13.0 +% git checkout releng/{rel-latest-next} % git cherry-pick -x $HASH --edit .... @@ -1006,9 +1006,9 @@ to do that. The `--abort` will cleanup the failed first attempt. If you do a MFC, and it goes horribly wrong and you want to start over, then the easiest way is to use `git reset --hard` like so: -[source,shell] +[source,shell,subs=attributes] .... -% git reset --hard freebsd/stable/12 +% git reset --hard freebsd/stable/{rel-latest-major} .... though if you have some revs you want to keep, and others you don't, using `git rebase -i` is better.