I noticed that <http://jk.gs/git-remote.html> mostly refers to remotes as "<name>", but in one case as "<remote>". "<remote>" is clearer than "<name>", and also follows the pattern of "<url>", "<branch>" and so on. Here follows a patch in which the usage is made consistent, as "<remote>" rather than "<name>". I hope the format is OK. Thanks, Daniele >From 3b9d6847286b70b9ee1711af5b9cf3dd7a91c2cc Mon Sep 17 00:00:00 2001 From: Daniele Procida <daniele@xxxxxxxx> Date: Tue, 27 Aug 2013 13:08:37 +0100 Subject: [PATCH] made git man remote more consistent --- Documentation/git-remote.txt | 56 ++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 9c3e3bf..12cdf04 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -10,16 +10,16 @@ SYNOPSIS -------- [verse] 'git remote' [-v | --verbose] -'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url> +'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <remote> <url> 'git remote rename' <old> <new> -'git remote remove' <name> -'git remote set-head' <name> (-a | -d | <branch>) -'git remote set-branches' [--add] <name> <branch>... -'git remote set-url' [--push] <name> <newurl> [<oldurl>] -'git remote set-url --add' [--push] <name> <newurl> -'git remote set-url --delete' [--push] <name> <url> -'git remote' [-v | --verbose] 'show' [-n] <name>... -'git remote prune' [-n | --dry-run] <name>... +'git remote remove' <remote> +'git remote set-head' <remote> (-a | -d | <branch>) +'git remote set-branches' [--add] <remote> <branch>... +'git remote set-url' [--push] <remote> <newurl> [<oldurl>] +'git remote set-url --add' [--push] <remote> <newurl> +'git remote set-url --delete' [--push] <remote> <url> +'git remote' [-v | --verbose] 'show' [-n] <remote>... +'git remote prune' [-n | --dry-run] <remote>... 'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...] DESCRIPTION @@ -45,26 +45,26 @@ subcommands are available to perform operations on the remotes. 'add':: -Adds a remote named <name> for the repository at -<url>. The command `git fetch <name>` can then be used to create and -update remote-tracking branches <name>/<branch>. +Adds a remote named <remote> for the repository at +<url>. The command `git fetch <remote>` can then be used to create and +update remote-tracking branches <remote>/<branch>. + -With `-f` option, `git fetch <name>` is run immediately after +With `-f` option, `git fetch <remote>` is run immediately after the remote information is set up. + -With `--tags` option, `git fetch <name>` imports every tag from the +With `--tags` option, `git fetch <remote>` imports every tag from the remote repository. + -With `--no-tags` option, `git fetch <name>` does not import tags from +With `--no-tags` option, `git fetch <remote>` does not import tags from the remote repository. + With `-t <branch>` option, instead of the default glob refspec for the remote to track all branches under -the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>` +the `refs/remotes/<remote>/` namespace, a refspec to track only `<branch>` is created. You can give more than one `-t <branch>` to track multiple branches without grabbing all branches. + -With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set +With `-m <master>` option, a symbolic-ref `refs/remotes/<remote>/HEAD` is set up to point at remote's `<master>` branch. See also the set-head command. + When a fetch mirror is created with `--mirror=fetch`, the refs will not @@ -88,29 +88,29 @@ the configuration file format. 'remove':: 'rm':: -Remove the remote named <name>. All remote-tracking branches and +Remove the remote named <remote>. All remote-tracking branches and configuration settings for the remote are removed. 'set-head':: Sets or deletes the default branch (i.e. the target of the -symbolic-ref `refs/remotes/<name>/HEAD`) for +symbolic-ref `refs/remotes/<remote>/HEAD`) for the named remote. Having a default branch for a remote is not required, but allows the name of the remote to be specified in lieu of a specific branch. For example, if the default branch for `origin` is set to `master`, then `origin` may be specified wherever you would normally specify `origin/master`. + -With `-d`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted. +With `-d`, the symbolic ref `refs/remotes/<remote>/HEAD` is deleted. + With `-a`, the remote is queried to determine its `HEAD`, then the -symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote +symbolic-ref `refs/remotes/<remote>/HEAD` is set to the same branch. e.g., if the remote `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will only work if `refs/remotes/origin/next` already exists; if not it must be fetched first. + -Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., "git +Use `<branch>` to set the symbolic-ref `refs/remotes/<remote>/HEAD` explicitly. e.g., "git remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/master`. This will only work if `refs/remotes/origin/master` already exists; if not it must be fetched first. @@ -144,17 +144,17 @@ error. 'show':: -Gives some information about the remote <name>. +Gives some information about the remote <remote>. + With `-n` option, the remote heads are not queried first with -`git ls-remote <name>`; cached information is used instead. +`git ls-remote <remote>`; cached information is used instead. 'prune':: -Deletes all stale remote-tracking branches under <name>. +Deletes all stale remote-tracking branches under <remote>. These stale branches have already been removed from the remote repository -referenced by <name>, but are still locally available in -"remotes/<name>". +referenced by <remote>, but are still locally available in +"remotes/<remote>". + With `--dry-run` option, report what branches will be pruned, but do not actually prune them. @@ -165,7 +165,7 @@ Fetch updates for a named set of remotes in the repository as defined by remotes.<group>. If a named group is not 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.<name>.skipDefaultUpdate set to true will +configuration parameter remote.<remote>.skipDefaultUpdate set to true will be updated. (See linkgit:git-config[1]). + With `--prune` option, prune all the remotes that are updated. -- 1.8.4 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html