[Bug 280233] Handbook: Wrong git instructions to switch quarterly branch

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=280233

            Bug ID: 280233
           Summary: Handbook: Wrong git instructions to switch quarterly
                    branch
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: majo-bugs.freebsd.org@cerny.sk

In FreeBSD handbook, section 4.5.1. Installing the Ports Collection
(https://docs.freebsd.org/en/books/handbook/ports/#ports-using-installation-methods),
subsection Procedure: Git Method are non-functional instruction to switch to a
different quarterly branch:

> 5. As needed, switch /usr/ports to a different quarterly branch:
> # git -C /usr/ports switch 2023Q1

However that does not work, it show the following error: "fatal: invalid
reference: 2023Q1", because the current clone is a shallow clone, as per
instruction:

> 3. Or, check out a copy of a quarterly branch:
> # git clone --depth 1 https://git.FreeBSD.org/ports.git -b 2023Q1 /usr/ports

The following works (when --depth 1 was used):

# cd /usr/ports
# git remote set-branches origin 2024Q3
# git fetch --depth 1 origin 2024Q3
# git checkout 2024Q3

The instruction for step 5 should be changed. Maybe the simple switch command
could remain there as an option when --depth 1 argument has been omitted.

-- 
You are receiving this mail because:
You are the assignee for the bug.