doc: git-remote fix ups
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Oct 8, 2020 at 22:23 UTC
89eed6fa99915042792946a92b61fc64fed04b24
1 file changed
+10
-10
Documentation/git-remote.txt
+10
-10
@@ -10,7 +10,7 @@ SYNOPSIS
10
--------
11
[verse]
12
'git remote' [-v | --verbose]
13
-'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>
13
+'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <url>
14
'git remote rename' <old> <new>
15
'git remote remove' <name>
16
'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>)
@@ -35,7 +35,7 @@ OPTIONS
35
-v::
36
--verbose::
37
Be a little more verbose and show remote url after name.
38
- NOTE: This must be placed between `remote` and `subcommand`.
38
+ NOTE: This must be placed between `remote` and subcommand.
39
40
41
COMMANDS
@@ -46,7 +46,7 @@ subcommands are available to perform operations on the remotes.
46
47
'add'::
48
49
-Adds a remote named <name> for the repository at
49
+Add a remote named <name> for the repository at
50
<url>. The command `git fetch <name>` can then be used to create and
51
update remote-tracking branches <name>/<branch>.
52
+
@@ -109,13 +109,13 @@ With `-d` or `--delete`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted.
109
+
110
With `-a` or `--auto`, the remote is queried to determine its `HEAD`, then the
111
symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
112
-`HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
112
+`HEAD` is pointed at `next`, `git remote set-head origin -a` will set
113
the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
114
only work if `refs/remotes/origin/next` already exists; if not it must be
115
fetched first.
116
+
117
-Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., "git
118
-remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to
117
+Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., `git
118
+remote set-head origin master` will set the symbolic-ref `refs/remotes/origin/HEAD` to
119
`refs/remotes/origin/master`. This will only work if
120
`refs/remotes/origin/master` already exists; if not it must be fetched first.
121
+
@@ -127,7 +127,7 @@ This can be used to track a subset of the available remote branches
127
after the initial setup for a remote.
128
+
129
The named branches will be interpreted as if specified with the
130
-`-t` option on the 'git remote add' command line.
130
+`-t` option on the `git remote add` command line.
131
+
132
With `--add`, instead of replacing the list of currently tracked
133
branches, adds to that list.
@@ -181,16 +181,16 @@ fetch --prune <name>`, except that no new references will be fetched.
181
See the PRUNING section of linkgit:git-fetch[1] for what it'll prune
182
depending on various configuration.
183
+
184
-With `--dry-run` option, report what branches will be pruned, but do not
184
+With `--dry-run` option, report what branches would be pruned, but do not
185
actually prune them.
186
187
'update'::
188
189
Fetch updates for remotes or remote groups in the repository as defined by
190
-remotes.<group>. If neither group nor remote is specified on the command line,
190
+`remotes.<group>`. If neither group nor remote is specified on the command line,
191
the configuration parameter remotes.default will be used; if
192
remotes.default is not defined, all remotes which do not have the
193
-configuration parameter remote.<name>.skipDefaultUpdate set to true will
193
+configuration parameter `remote.<name>.skipDefaultUpdate` set to true will
194
be updated. (See linkgit:git-config[1]).
195
+
196
With `--prune` option, run pruning against all the remotes that are updated.