Bug 279503 - Committer's Guide use the outdated stable/12 branch as examples
Summary: Committer's Guide use the outdated stable/12 branch as examples
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-06-03 16:16 UTC by Wolfram Schneider
Modified: 2024-11-16 10:45 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Wolfram Schneider freebsd_committer freebsd_triage 2024-06-03 16:16:39 UTC
The FreeBSD Committer's Guide use the outdated stable/12 branch as examples. We should update to stable/14 

cd doc/documentation/content/en/articles/committers-guide
git grep stable-12
_index.adoc:% git checkout -b no-color-ls-stable-12   # create another name for this branch
_index.adoc:Then create a new name for it (no-color-ls-stable-12) in case you need to get back to it.
_index.adoc:% git worktree add ../freebsd-stable-12 stable/12
_index.adoc:this will checkout `stable/12` into a directory named `freebsd-stable-12` that's a peer to the `freebsd-current` directory.
_index.adoc:% cd ../freebsd-stable-12
_index.po:"% git checkout -b no-color-ls-stable-12   # create another name for this branch\n"
_index.po:"Then create a new name for it (no-color-ls-stable-12) in case you need to get back to it.\n"
_index.po:msgid "% cd freebsd-current % git worktree add ../freebsd-stable-12 stable/12"
_index.po:"this will checkout `stable/12` into a directory named `freebsd-stable-12` that's a peer to the `freebsd-current` directory.\n"
_index.po:"upstream now local and current tree updated % cd ../freebsd-stable-12 % git "



git grep stable/12
_index.adoc:For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`.
_index.adoc:If you wish to shift from stable/12 to the current branch.
_index.adoc:If we pretend the example above was relative to stable/12, then to move to `main`, I'd suggest the following:
_index.adoc:% git rebase -i stable/12 no-color-ls --onto main
_index.adoc: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
_index.adoc:% git reset --hard freebsd/stable/12
_index.adoc:% git worktree add ../freebsd-stable-12 stable/12
_index.adoc:this will checkout `stable/12` into a directory named `freebsd-stable-12` that's a peer to the `freebsd-current` directory.
_index.adoc:% git merge --ff-only freebsd/stable/12
_index.adoc:# now your stable/12 is up to date too
_index.po:msgid "For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`."
_index.po:"If you wish to shift from stable/12 to the current branch.  If you have a "
_index.po:"If we pretend the example above was relative to stable/12, then to move to `main`, I'd suggest the following:\n"
_index.po:"% git rebase -i stable/12 no-color-ls --onto main\n"
_index.po:"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\n"
_index.po:msgid "% git reset --hard freebsd/stable/12"
_index.po:msgid "% cd freebsd-current % git worktree add ../freebsd-stable-12 stable/12"
_index.po:"this will checkout `stable/12` into a directory named `freebsd-stable-12` that's a peer to the `freebsd-current` directory.\n"
_index.po:"merge --ff-only freebsd/stable/12 # now your stable/12 is up to date too"
Comment 1 Li-Wen Hsu freebsd_committer freebsd_triage 2024-06-03 16:26:43 UTC
Or we can change it to not depending on a specified version, say, `stable/N` or something like that.
Comment 2 Wolfram Schneider freebsd_committer freebsd_triage 2024-06-04 16:13:01 UTC
(In reply to Li-Wen Hsu from comment #1)

A generic version as stable/N is fine for me.
Comment 3 Ed Maste freebsd_committer freebsd_triage 2024-06-06 12:53:57 UTC
(In reply to Wolfram Schneider from comment #2)
Note that a generic form can be confusing to some users -- I addressed a PR recently that reported https://cgit.freebsd.org/${repo}/ did not work.
Comment 4 Chris Moerz 2024-11-09 11:13:05 UTC
I have taken the liberty to create a review for this:
https://reviews.freebsd.org/D47496

Feedback welcome!