From: Daniele Procida Date: Tue, 27 Aug 2013 14:10:08 GMT Subject: PATCH/RFC man git remote, use of vs Message-ID: <20130827141008.578740119@smtpauth.cf.ac.uk> I noticed that mostly refers to remotes as "", but in one case as "". "" is clearer than "", and also follows the pattern of "", "" and so on. Here follows a patch in which the usage is made consistent, as "" rather than "". I hope the format is OK. Thanks, Daniele >From 3b9d6847286b70b9ee1711af5b9cf3dd7a91c2cc Mon Sep 17 00:00:00 2001 From: Daniele Procida 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 ] [-m ] [-f] [--[no-]tags] [--mirror=] +'git remote add' [-t ] [-m ] [-f] [--[no-]tags] [--mirror=] 'git remote rename' -'git remote remove' -'git remote set-head' (-a | -d | ) -'git remote set-branches' [--add] ... -'git remote set-url' [--push] [] -'git remote set-url --add' [--push] -'git remote set-url --delete' [--push] -'git remote' [-v | --verbose] 'show' [-n] ... -'git remote prune' [-n | --dry-run] ... +'git remote remove' +'git remote set-head' (-a | -d | ) +'git remote set-branches' [--add] ... +'git remote set-url' [--push] [] +'git remote set-url --add' [--push] +'git remote set-url --delete' [--push] +'git remote' [-v | --verbose] 'show' [-n] ... +'git remote prune' [-n | --dry-run] ... 'git remote' [-v | --verbose] 'update' [-p | --prune] [( | )...] DESCRIPTION @@ -45,26 +45,26 @@ subcommands are available to perform operations on the remotes. 'add':: -Adds a remote named for the repository at -. The command `git fetch ` can then be used to create and -update remote-tracking branches /. +Adds a remote named for the repository at +. The command `git fetch ` can then be used to create and +update remote-tracking branches /. + -With `-f` option, `git fetch ` is run immediately after +With `-f` option, `git fetch ` is run immediately after the remote information is set up. + -With `--tags` option, `git fetch ` imports every tag from the +With `--tags` option, `git fetch ` imports every tag from the remote repository. + -With `--no-tags` option, `git fetch ` does not import tags from +With `--no-tags` option, `git fetch ` does not import tags from the remote repository. + With `-t ` option, instead of the default glob refspec for the remote to track all branches under -the `refs/remotes//` namespace, a refspec to track only `` +the `refs/remotes//` namespace, a refspec to track only `` is created. You can give more than one `-t ` to track multiple branches without grabbing all branches. + -With `-m ` option, a symbolic-ref `refs/remotes//HEAD` is set +With `-m ` option, a symbolic-ref `refs/remotes//HEAD` is set up to point at remote's `` 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 . All remote-tracking branches and +Remove the remote named . 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//HEAD`) for +symbolic-ref `refs/remotes//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//HEAD` is deleted. +With `-d`, the symbolic ref `refs/remotes//HEAD` is deleted. + With `-a`, the remote is queried to determine its `HEAD`, then the -symbolic-ref `refs/remotes//HEAD` is set to the same branch. e.g., if the remote +symbolic-ref `refs/remotes//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 `` to set the symbolic-ref `refs/remotes//HEAD` explicitly. e.g., "git +Use `` to set the symbolic-ref `refs/remotes//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 . +Gives some information about the remote . + With `-n` option, the remote heads are not queried first with -`git ls-remote `; cached information is used instead. +`git ls-remote `; cached information is used instead. 'prune':: -Deletes all stale remote-tracking branches under . +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/". +referenced by , but are still locally available in +"remotes/". + 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.. 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..skipDefaultUpdate set to true will +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. -- 1.8.4