undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: git-remote fix ups

Browse Source 
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jean-Noël Avila 2020-10-08 22:23:56 +02:00 committed by Junio C Hamano
parent 49fbf9ed71
commit 89eed6fa99
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/git-remote.txt
View File

@ -10,7 +10,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git remote' [-v | --verbose] '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)] <name> <url>
'git remote rename' <old> <new> 'git remote rename' <old> <new>
'git remote remove' <name> 'git remote remove' <name>
'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>) 'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>)
@ -35,7 +35,7 @@ OPTIONS
-v:: -v::
--verbose:: --verbose::
Be a little more verbose and show remote url after name. Be a little more verbose and show remote url after name.
NOTE: This must be placed between `remote` and `subcommand`. NOTE: This must be placed between `remote` and subcommand.
COMMANDS COMMANDS
@ -46,7 +46,7 @@ subcommands are available to perform operations on the remotes.
'add':: 'add'::
Adds a remote named <name> for the repository at Add a remote named <name> for the repository at
<url>. The command `git fetch <name>` can then be used to create and <url>. The command `git fetch <name>` can then be used to create and
update remote-tracking branches <name>/<branch>. update remote-tracking branches <name>/<branch>.
+ +
@ -109,13 +109,13 @@ With `-d` or `--delete`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted.
+ +
With `-a` or `--auto`, the remote is queried to determine its `HEAD`, then the With `-a` or `--auto`, 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/<name>/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 `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 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 only work if `refs/remotes/origin/next` already exists; if not it must be
fetched first. 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/<name>/HEAD` explicitly. e.g., `git
remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to 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`. This will only work if
`refs/remotes/origin/master` already exists; if not it must be fetched first. `refs/remotes/origin/master` already exists; if not it must be fetched first.
+ +
@ -127,7 +127,7 @@ This can be used to track a subset of the available remote branches
after the initial setup for a remote. after the initial setup for a remote.
+ +
The named branches will be interpreted as if specified with the The named branches will be interpreted as if specified with the
`-t` option on the 'git remote add' command line. `-t` option on the `git remote add` command line.
+ +
With `--add`, instead of replacing the list of currently tracked With `--add`, instead of replacing the list of currently tracked
branches, adds to that list. branches, adds to that list.
@ -181,16 +181,16 @@ fetch --prune <name>`, except that no new references will be fetched.
See the PRUNING section of linkgit:git-fetch[1] for what it'll prune See the PRUNING section of linkgit:git-fetch[1] for what it'll prune
depending on various configuration. depending on various configuration.
+ +
With `--dry-run` option, report what branches will be pruned, but do not With `--dry-run` option, report what branches would be pruned, but do not
actually prune them. actually prune them.
'update':: 'update'::
Fetch updates for remotes or remote groups in the repository as defined by Fetch updates for remotes or remote groups in the repository as defined by
remotes.<group>. If neither group nor remote is specified on the command line, `remotes.<group>`. If neither group nor remote is specified on the command line,
the configuration parameter remotes.default will be used; if the configuration parameter remotes.default will be used; if
remotes.default is not defined, all remotes which do not have the remotes.default is not defined, all remotes which do not have the
configuration parameter remote.<name>.skipDefaultUpdate set to true will configuration parameter `remote.<name>.skipDefaultUpdate` set to true will
be updated. (See linkgit:git-config[1]). be updated. (See linkgit:git-config[1]).
+ +
With `--prune` option, run pruning against all the remotes that are updated. With `--prune` option, run pruning against all the remotes that are updated.