From: Junio C Hamano Date: Mon, 4 Jun 2018 12:39:48 +0000 (+0900) Subject: Merge branch 'nd/remote-update-doc' X-Git-Tag: v2.18.0-rc1~5 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/643a9ea3e0d2937155bbce43e17bb132dc7166ff?ds=inline;hp=-c Merge branch 'nd/remote-update-doc' "git remote update" can take both a single remote nickname and a nickname for remote groups, but only one of them was documented. * nd/remote-update-doc: remote: doc typofix remote.txt: update documentation for 'update' command --- 643a9ea3e0d2937155bbce43e17bb132dc7166ff diff --combined Documentation/git-remote.txt index 595948da53,77e9f00000..0cad37fb81 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@@ -172,28 -172,24 +172,28 @@@ With `-n` option, the remote heads are 'prune':: -Deletes all stale remote-tracking branches under . -These stale branches have already been removed from the remote repository -referenced by , but are still locally available in -"remotes/". +Deletes stale references associated with . By default, stale +remote-tracking branches under are deleted, but depending on +global configuration and the configuration of the remote we might even +prune local tags that haven't been pushed there. Equivalent to `git +fetch --prune `, except that no new references will be fetched. ++ +See the PRUNING section of linkgit:git-fetch[1] for what it'll prune +depending on various configuration. + With `--dry-run` option, report what branches will be pruned, but do not actually prune them. 'update':: - Fetch updates for a named set of remotes in the repository as defined by - remotes.. If a named group is not specified on the command line, + Fetch updates for remotes or remote groups in the repository as defined by + remotes.. If neither group nor remote is specified on the command line, the configuration parameter remotes.default will be 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 linkgit:git-config[1]). + -With `--prune` option, prune all the remotes that are updated. +With `--prune` option, run pruning against all the remotes that are updated. DISCUSSION @@@ -203,7 -199,7 +203,7 @@@ The remote configuration is achieved us `remote.origin.fetch` configuration variables. (See linkgit:git-config[1]). -Examples +EXAMPLES -------- * Add a new remote, fetch, and check out a branch from it