From: Jean-Noël Avila Date: Sat, 20 Dec 2025 19:16:27 +0000 (+0000) Subject: doc: convert git-remote to synopsis style X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=acffc5e9e54f5632abefe53d0914007709d409ce;p=thirdparty%2Fgit.git doc: convert git-remote to synopsis style - Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - Use __ instead of in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. - also convert first sentences to imperative mood where applicable Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-remote.adoc b/Documentation/git-remote.adoc index 932a5c3ea4..eaae30aa88 100644 --- a/Documentation/git-remote.adoc +++ b/Documentation/git-remote.adoc @@ -8,20 +8,20 @@ git-remote - Manage set of tracked repositories SYNOPSIS -------- -[verse] -'git remote' [-v | --verbose] -'git remote add' [-t ] [-m ] [-f] [--[no-]tags] [--mirror=(fetch|push)] -'git remote rename' [--[no-]progress] -'git remote remove' -'git remote set-head' (-a | --auto | -d | --delete | ) -'git remote set-branches' [--add] ... -'git remote get-url' [--push] [--all] -'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] [( | )...] +[synopsis] +git remote [-v | --verbose] +git remote add [-t ] [-m ] [-f] [--[no-]tags] [--mirror=(fetch|push)] +git remote rename [--[no-]progress] +git remote remove +git remote set-head (-a | --auto | -d | --delete | ) +git remote set-branches [--add] ... +git remote get-url [--push] [--all] +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 ----------- @@ -32,8 +32,8 @@ Manage the set of repositories ("remotes") whose branches you track. OPTIONS ------- --v:: ---verbose:: +`-v`:: +`--verbose`:: Be a little more verbose and show remote url after name. For promisor remotes, also show which filters (`blob:none` etc.) are configured. @@ -43,14 +43,14 @@ OPTIONS COMMANDS -------- -With no arguments, shows a list of existing remotes. Several +With no arguments, show a list of existing remotes. Several subcommands are available to perform operations on the remotes. -'add':: +`add`:: -Add a remote named for the repository at -. The command `git fetch ` can then be used to create and -update remote-tracking branches /. +Add 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 the remote information is set up. @@ -66,40 +66,40 @@ By default, only tags on fetched branches are imported + 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 -up to point at remote's `` branch. See also the set-head command. +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 -be stored in the 'refs/remotes/' namespace, but rather everything in -'refs/' on the remote will be directly mirrored into 'refs/' in the +be stored in the `refs/remotes/` namespace, but rather everything in +`refs/` on the remote will be directly mirrored into `refs/` in the local repository. This option only makes sense in bare repositories, because a fetch would overwrite any local commits. + When a push mirror is created with `--mirror=push`, then `git push` will always behave as if `--mirror` was passed. -'rename':: +`rename`:: -Rename the remote named to . All remote-tracking branches and +Rename the remote named __ to __. All remote-tracking branches and configuration settings for the remote are updated. + -In case and are the same, and is a file under +In case __ and __ are the same, and __ is a file under `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to the configuration file format. -'remove':: -'rm':: +`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':: +`set-head`:: -Sets or deletes the default branch (i.e. the target of the +Set or delete the default branch (i.e. the target of the 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 @@ -116,15 +116,15 @@ the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This 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. + -'set-branches':: +`set-branches`:: -Changes the list of branches tracked by the named remote. +Change the list of branches tracked by the named remote. This can be used to track a subset of the available remote branches after the initial setup for a remote. + @@ -134,7 +134,7 @@ The named branches will be interpreted as if specified with the With `--add`, instead of replacing the list of currently tracked branches, adds to that list. -'get-url':: +`get-url`:: Retrieves the URLs for a remote. Configurations for `insteadOf` and `pushInsteadOf` are expanded here. By default, only the first URL is listed. @@ -143,18 +143,18 @@ With `--push`, push URLs are queried rather than fetch URLs. + With `--all`, all URLs for the remote will be listed. -'set-url':: +`set-url`:: -Changes URLs for the remote. Sets first URL for remote that matches -regex (first URL if no is given) to . If - doesn't match any URL, an error occurs and nothing is changed. +Change URLs for the remote. Sets first URL for remote __ that matches +regex __ (first URL if no __ is given) to __. If +__ doesn't match any URL, an error occurs and nothing is changed. + With `--push`, push URLs are manipulated instead of fetch URLs. + With `--add`, instead of changing existing URLs, new URL is added. + With `--delete`, instead of changing existing URLs, all URLs matching -regex are deleted for remote . Trying to delete all +regex __ are deleted for remote __. Trying to delete all non-push URLs is an error. + Note that the push URL and the fetch URL, even though they can @@ -165,17 +165,17 @@ fetch from one place (e.g. your upstream) and push to another (e.g. your publishing repository), use two separate remotes. -'show':: +`show`:: -Gives some information about the remote . +Give some information about the remote __. + With `-n` option, the remote heads are not queried first with `git ls-remote `; cached information is used instead. -'prune':: +`prune`:: -Deletes stale references associated with . By default, stale -remote-tracking branches under are deleted, but depending on +Delete stale references associated with __. By default, stale +remote-tracking branches under __ are deleted, but depending on global configuration and the configuration of the remote we might even prune local tags that haven't been pushed there. Equivalent to `git fetch --prune `, except that no new references will be fetched. @@ -186,13 +186,13 @@ depending on various configuration. With `--dry-run` option, report what branches would be pruned, but do not actually prune them. -'update':: +`update`:: Fetch updates for remotes or remote groups in the repository as defined by `remotes.`. If neither group nor remote is 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 +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 be updated. (See linkgit:git-config[1]). + With `--prune` option, run pruning against all the remotes that are updated. @@ -210,7 +210,7 @@ EXIT STATUS On success, the exit status is `0`. -When subcommands such as 'add', 'rename', and 'remove' can't find the +When subcommands such as `add`, `rename`, and `remove` can't find the remote in question, the exit status is `2`. When the remote already exists, the exit status is `3`. @@ -247,7 +247,7 @@ $ git switch -c staging staging/master ... ------------ -* Imitate 'git clone' but track only selected branches +* Imitate `git clone` but track only selected branches + ------------ $ mkdir project.git