{"thread":{"id":"34781","subject":"PATCH/RFC man git remote, use of <remote> vs <name>","startedAt":"2013-08-27T14:10:08Z","lastAt":"2013-08-27T14:10:08Z","messageCount":1,"participants":["Daniele Procida"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"225995","messageId":"20130827141008.578740119@smtpauth.cf.ac.uk","threadId":"34781","inReplyTo":null,"subject":"PATCH/RFC man git remote, use of <remote> vs <name>","fromName":"Daniele Procida","fromEmail":"daniele@vurt.org","sentAt":"2013-08-27T14:10:08Z","receivedAt":"2013-08-27T14:10:08Z","isPatch":false,"sender":{"key":"daniele@vurt.org","avatar":null},"body":"I noticed that <http://jk.gs/git-remote.html> mostly refers to remotes as \"<name>\", but in one case as \"<remote>\".\n\n\"<remote>\" is clearer than \"<name>\", and also follows the pattern of \"<url>\", \"<branch>\" and so on.\n\nHere follows a patch in which the usage is made consistent, as \"<remote>\" rather than \"<name>\".\n\nI hope the format is OK.\n\nThanks,\n\nDaniele\n\n>From 3b9d6847286b70b9ee1711af5b9cf3dd7a91c2cc Mon Sep 17 00:00:00 2001\nFrom: Daniele Procida <daniele@vurt.org>\nDate: Tue, 27 Aug 2013 13:08:37 +0100\nSubject: [PATCH] made git man remote more consistent\n\n---\n Documentation/git-remote.txt | 56 ++++++++++++++++++++++----------------------\n 1 file changed, 28 insertions(+), 28 deletions(-)\n\ndiff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt\nindex 9c3e3bf..12cdf04 100644\n--- a/Documentation/git-remote.txt\n+++ b/Documentation/git-remote.txt\n@@ -10,16 +10,16 @@ SYNOPSIS\n --------\n [verse]\n 'git remote' [-v | --verbose]\n-'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>\n+'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <remote> <url>\n 'git remote rename' <old> <new>\n-'git remote remove' <name>\n-'git remote set-head' <name> (-a | -d | <branch>)\n-'git remote set-branches' [--add] <name> <branch>...\n-'git remote set-url' [--push] <name> <newurl> [<oldurl>]\n-'git remote set-url --add' [--push] <name> <newurl>\n-'git remote set-url --delete' [--push] <name> <url>\n-'git remote' [-v | --verbose] 'show' [-n] <name>...\n-'git remote prune' [-n | --dry-run] <name>...\n+'git remote remove' <remote>\n+'git remote set-head' <remote> (-a | -d | <branch>)\n+'git remote set-branches' [--add] <remote> <branch>...\n+'git remote set-url' [--push] <remote> <newurl> [<oldurl>]\n+'git remote set-url --add' [--push] <remote> <newurl>\n+'git remote set-url --delete' [--push] <remote> <url>\n+'git remote' [-v | --verbose] 'show' [-n] <remote>...\n+'git remote prune' [-n | --dry-run] <remote>...\n 'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]\n \n DESCRIPTION\n@@ -45,26 +45,26 @@ subcommands are available to perform operations on the remotes.\n \n 'add'::\n \n-Adds a remote named <name> for the repository at\n-<url>.  The command `git fetch <name>` can then be used to create and\n-update remote-tracking branches <name>/<branch>.\n+Adds a remote named <remote> for the repository at\n+<url>.  The command `git fetch <remote>` can then be used to create and\n+update remote-tracking branches <remote>/<branch>.\n +\n-With `-f` option, `git fetch <name>` is run immediately after\n+With `-f` option, `git fetch <remote>` is run immediately after\n the remote information is set up.\n +\n-With `--tags` option, `git fetch <name>` imports every tag from the\n+With `--tags` option, `git fetch <remote>` imports every tag from the\n remote repository.\n +\n-With `--no-tags` option, `git fetch <name>` does not import tags from\n+With `--no-tags` option, `git fetch <remote>` does not import tags from\n the remote repository.\n +\n With `-t <branch>` option, instead of the default glob\n refspec for the remote to track all branches under\n-the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>`\n+the `refs/remotes/<remote>/` namespace, a refspec to track only `<branch>`\n is created.  You can give more than one `-t <branch>` to track\n multiple branches without grabbing all branches.\n +\n-With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set\n+With `-m <master>` option, a symbolic-ref `refs/remotes/<remote>/HEAD` is set\n up to point at remote's `<master>` branch. See also the set-head command.\n +\n When a fetch mirror is created with `--mirror=fetch`, the refs will not\n@@ -88,29 +88,29 @@ the configuration file format.\n 'remove'::\n 'rm'::\n \n-Remove the remote named <name>. All remote-tracking branches and\n+Remove the remote named <remote>. All remote-tracking branches and\n configuration settings for the remote are removed.\n \n 'set-head'::\n \n Sets or deletes the default branch (i.e. the target of the\n-symbolic-ref `refs/remotes/<name>/HEAD`) for\n+symbolic-ref `refs/remotes/<remote>/HEAD`) for\n the named remote. Having a default branch for a remote is not required,\n but allows the name of the remote to be specified in lieu of a specific\n branch. For example, if the default branch for `origin` is set to\n `master`, then `origin` may be specified wherever you would normally\n specify `origin/master`.\n +\n-With `-d`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted.\n+With `-d`, the symbolic ref `refs/remotes/<remote>/HEAD` is deleted.\n +\n With `-a`, the remote is queried to determine its `HEAD`, then the\n-symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote\n+symbolic-ref `refs/remotes/<remote>/HEAD` is set to the same branch. e.g., if the remote\n `HEAD` is pointed at `next`, \"`git remote set-head origin -a`\" will set\n the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will\n only work if `refs/remotes/origin/next` already exists; if not it must be\n fetched first.\n +\n-Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., \"git\n+Use `<branch>` to set the symbolic-ref `refs/remotes/<remote>/HEAD` explicitly. e.g., \"git\n remote set-head origin master\" will set the symbolic-ref `refs/remotes/origin/HEAD` to\n `refs/remotes/origin/master`. This will only work if\n `refs/remotes/origin/master` already exists; if not it must be fetched first.\n@@ -144,17 +144,17 @@ error.\n \n 'show'::\n \n-Gives some information about the remote <name>.\n+Gives some information about the remote <remote>.\n +\n With `-n` option, the remote heads are not queried first with\n-`git ls-remote <name>`; cached information is used instead.\n+`git ls-remote <remote>`; cached information is used instead.\n \n 'prune'::\n \n-Deletes all stale remote-tracking branches under <name>.\n+Deletes all stale remote-tracking branches under <remote>.\n These stale branches have already been removed from the remote repository\n-referenced by <name>, but are still locally available in\n-\"remotes/<name>\".\n+referenced by <remote>, but are still locally available in\n+\"remotes/<remote>\".\n +\n With `--dry-run` option, report what branches will be pruned, but do not\n actually prune them.\n@@ -165,7 +165,7 @@ Fetch updates for a named set of remotes in the repository as defined by\n remotes.<group>.  If a named group is not specified on the command line,\n the configuration parameter remotes.default will be used; if\n remotes.default is not defined, all remotes which do not have the\n-configuration parameter remote.<name>.skipDefaultUpdate set to true will\n+configuration parameter remote.<remote>.skipDefaultUpdate set to true will\n be updated.  (See linkgit:git-config[1]).\n +\n With `--prune` option, prune all the remotes that are updated.\n-- \n1.8.4\n"}]}