Bug 275713 - git commands are incorrect for updating source tree
Summary: git commands are incorrect for updating source tree
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Li-Wen Hsu
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-12-12 03:26 UTC by Ian
Modified: 2023-12-13 19:30 UTC (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
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 freebsd_triage 2023-12-13 19:30:00 UTC 
Fixed, thanks!
Comment 2 commit-hook freebsd_committer freebsd_triage 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(-)