Bug 275713

Summary:	git commands are incorrect for updating source tree
Product:	Documentation	Reporter:	Ian <yoitsmeremember+fbsd>
Component:	Books & Articles	Assignee:	Li-Wen Hsu <lwhsu>
Status:	Closed FIXED
Severity:	Affects Only Me	CC:	emaste, lwhsu
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description Ian 2023-12-12 03:26:15 UTC

In the handbook, specifically: https://docs.freebsd.org/en/books/handbook/cutting-edge/#updating-src-obtaining-src

...there is a command listed for updating the source tree via git.  It states that the tree can be updated with `git pull /usr/src`; however, this is incorrect.  To properly update the source tree via git, the command should be `git -C /usr/src pull`, or alternatively, `cd /usr/src` followed by `git pull`.

Comment 1 Li-Wen Hsu freebsd_committer

2023-12-13 19:30:00 UTC

Fixed, thanks!

Comment 2 commit-hook freebsd_committer

2023-12-13 19:30:25 UTC

A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=f83eb8e5810ee1fa616cd431b6afaaabe1ff9d81

commit f83eb8e5810ee1fa616cd431b6afaaabe1ff9d81
Author:     Li-Wen Hsu <lwhsu@FreeBSD.org>
AuthorDate: 2023-12-13 19:27:59 +0000
Commit:     Li-Wen Hsu <lwhsu@FreeBSD.org>
CommitDate: 2023-12-13 19:27:59 +0000

    handbook: correct the git-pull command when a target directory specified

    PR:             275713
    Reported by:    Ian <yoitsmeremember+fbsd@gmail.com>

 documentation/content/en/books/handbook/cutting-edge/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)