X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-remote.txt;h=bb99810ec76f93ff1cdc59aacdf592c64419701a;hb=19a31f9c1a6b18abd8a7f20d616516afca36a6a3;hp=4b263c249cd93695b1c373887600d335685e82bb;hpb=ada59fcd3230e661bc1110702a2fb4ef76371bc1;p=git.git diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 4b263c249..bb99810ec 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -9,12 +9,12 @@ git-remote - manage set of tracked repositories SYNOPSIS -------- [verse] -'git-remote' -'git-remote' add [-t ] [-m ] [-f] [--mirror] -'git-remote' rm -'git-remote' show -'git-remote' prune -'git-remote' update [group] +'git remote' [-v | --verbose] +'git remote add' [-t ] [-m ] [-f] [--mirror] +'git remote rm' +'git remote show' [-n] +'git remote prune' [-n | --dry-run] +'git remote update' [group] DESCRIPTION ----------- @@ -22,6 +22,14 @@ DESCRIPTION Manage the set of repositories ("remotes") whose branches you track. +OPTIONS +------- + +-v:: +--verbose:: + Be a little more verbose and show remote url after name. + + COMMANDS -------- @@ -47,9 +55,11 @@ With `-m ` option, `$GIT_DIR/remotes//HEAD` is set up to point at remote's `` branch instead of whatever branch the `HEAD` at the remote repository actually points at. + -In mirror mode, enabled with `--mirror`, the refs will not be stored +In mirror mode, enabled with `\--mirror`, the refs will not be stored in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option -only makes sense in bare repositories. +only makes sense in bare repositories. If a remote uses mirror +mode, furthermore, `git push` will always behave as if `\--mirror` +was passed. 'rm':: @@ -70,9 +80,8 @@ These stale branches have already been removed from the remote repository referenced by , but are still locally available in "remotes/". + -With `-n` option, the remote heads are not confirmed first with `git -ls-remote `; cached information is used instead. Use with -caution. +With `--dry-run` option, report what branches will be pruned, but do no +actually prune them. 'update':: @@ -81,7 +90,7 @@ remotes.. If a named group is not specified on the command line, the configuration parameter remotes.default will get used; if remotes.default is not defined, all remotes which do not have the configuration parameter remote..skipDefaultUpdate set to true will -be updated. (See gitlink:git-config[1]). +be updated. (See linkgit:git-config[1]). DISCUSSION @@ -89,7 +98,7 @@ DISCUSSION The remote configuration is achieved using the `remote.origin.url` and `remote.origin.fetch` configuration variables. (See -gitlink:git-config[1]). +linkgit:git-config[1]). Examples -------- @@ -115,7 +124,7 @@ $ git checkout -b nfs linux-nfs/master ... ------------ -* Imitate 'git clone' but track only selected branches +* Imitate 'git-clone' but track only selected branches + ------------ $ mkdir project.git @@ -126,11 +135,11 @@ $ git merge origin ------------ -See Also +SEE ALSO -------- -gitlink:git-fetch[1] -gitlink:git-branch[1] -gitlink:git-config[1] +linkgit:git-fetch[1] +linkgit:git-branch[1] +linkgit:git-config[1] Author ------ @@ -144,4 +153,4 @@ Documentation by J. Bruce Fields and the git-list . GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite