Merge pull request #540 from umekikazuya/document-clone-config
Some checks failed
integration / test (push) Has been cancelled
tagpr / tagpr (push) Has been cancelled
test / test (macOS-latest) (push) Has been cancelled
test / test (ubuntu-latest) (push) Has been cancelled
test / test (windows-latest) (push) Has been cancelled

docs: mention clone.defaultRemoteName
This commit is contained in:
Masayuki Matsuki 2026-08-22 13:58:52 +09:00 committed by GitHub
commit 2474201bcc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -117,6 +117,10 @@ ghq.<url>.root::
you can specify a repository-specific root directory instead of the common ghq root directory. + you can specify a repository-specific root directory instead of the common ghq root directory. +
The URL is matched against '<url>' using 'git config --get-urlmatch'. The URL is matched against '<url>' using 'git config --get-urlmatch'.
Since `ghq get` runs `git clone` for Git repositories, git's own configuration applies as
well. For example, `clone.defaultRemoteName` changes the name of the created remote, which
is `origin` by default. +
To get this configuration variable effective, you will need Git 2.30 or higher.
=== Example configuration (.gitconfig): === Example configuration (.gitconfig):