Skip to content

doc: convert git-status, git remote and git stage to synopsis style #2020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jnavila wants to merge 5 commits into
base: master
Choose a base branch
from
Open

doc: convert git-status, git remote and git stage to synopsis style #2020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d470451
doc: fix t0450-txt-doc-vs-help to select only first synopsis block
jnavila Dec 20, 2025
08f3bb0
doc: convert git-status to synopsis style
jnavila Dec 18, 2025
de0deb3
doc: convert git-status tables to AsciiDoc format
jnavila Dec 18, 2025
3c125bb
doc: convert git stage to use synopsis block
jnavila Dec 20, 2025
e6012eb
doc: convert git-remote to synopsis style
jnavila Dec 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 53 additions & 53 deletions Documentation/git-remote.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ git-remote - Manage set of tracked repositories

SYNOPSIS
--------
[verse]
'git remote' [-v | --verbose]
'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <URL>
'git remote rename' [--[no-]progress] <old> <new>
'git remote remove' <name>
'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>)
'git remote set-branches' [--add] <name> <branch>...
'git remote get-url' [--push] [--all] <name>
'git remote set-url' [--push] <name> <newurl> [<oldurl>]
'git remote set-url --add' [--push] <name> <newurl>
'git remote set-url --delete' [--push] <name> <URL>
'git remote' [-v | --verbose] 'show' [-n] <name>...
'git remote prune' [-n | --dry-run] <name>...
'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]
[synopsis]
git remote [-v | --verbose]
git remote add [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <URL>
git remote rename [--[no-]progress] <old> <new>
git remote remove <name>
git remote set-head <name> (-a | --auto | -d | --delete | <branch>)
git remote set-branches [--add] <name> <branch>...
git remote get-url [--push] [--all] <name>
git remote set-url [--push] <name> <newurl> [<oldurl>]
git remote set-url --add [--push] <name> <newurl>
git remote set-url --delete [--push] <name> <URL>
git remote [-v | --verbose] show [-n] <name>...
git remote prune [-n | --dry-run] <name>...
git remote [-v | --verbose] update [-p | --prune] [(<group> | <remote>)...]

DESCRIPTION
-----------
Expand All @@ -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.
Expand All @@ -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 <name> for the repository at
<URL>. The command `git fetch <name>` can then be used to create and
update remote-tracking branches <name>/<branch>.
Add a remote named _<name>_ for the repository at
_<URL>_. The command `git fetch <name>` can then be used to create and
update remote-tracking branches `<name>/<branch>`.
+
With `-f` option, `git fetch <name>` is run immediately after
the remote information is set up.
Expand All @@ -66,40 +66,40 @@ By default, only tags on fetched branches are imported
+
With `-t <branch>` option, instead of the default glob
refspec for the remote to track all branches under
the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>`
the `refs/remotes/<name>/` namespace, a refspec to track only _<branch>_
is created. You can give more than one `-t <branch>` to track
multiple branches without grabbing all branches.
+
With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set
up to point at remote's `<master>` branch. See also the set-head command.
up to point at remote's _<master>_ 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 <old> to <new>. All remote-tracking branches and
Rename the remote named _<old>_ to _<new>_. All remote-tracking branches and
configuration settings for the remote are updated.
+
In case <old> and <new> are the same, and <old> is a file under
In case _<old>_ and _<new>_ are the same, and _<old>_ 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 <name>. All remote-tracking branches and
Remove the remote named _<name>_. 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/<name>/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
Expand All @@ -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 `<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
`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.
+
Expand All @@ -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.
Expand All @@ -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 <name> that matches
regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
<oldurl> doesn't match any URL, an error occurs and nothing is changed.
Change URLs for the remote. Sets first URL for remote _<name>_ that matches
regex _<oldurl>_ (first URL if no _<oldurl>_ is given) to _<newurl>_. If
_<oldurl>_ 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 <URL> are deleted for remote <name>. Trying to delete all
regex _<URL>_ are deleted for remote _<name>_. Trying to delete all
non-push URLs is an error.
+
Note that the push URL and the fetch URL, even though they can
Expand All @@ -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 <name>.
Give some information about the remote _<name>_.
+
With `-n` option, the remote heads are not queried first with
`git ls-remote <name>`; cached information is used instead.

'prune'::
`prune`::

Deletes stale references associated with <name>. By default, stale
remote-tracking branches under <name> are deleted, but depending on
Delete stale references associated with _<name>_. By default, stale
remote-tracking branches under _<name>_ 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 <name>`, except that no new references will be fetched.
Expand All @@ -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.<group>`. 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.<name>.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.<name>.skipDefaultUpdate` set to `true` will
be updated. (See linkgit:git-config[1]).
+
With `--prune` option, run pruning against all the remotes that are updated.
Expand All @@ -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`.

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-stage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ git-stage - Add file contents to the staging area

SYNOPSIS
--------
[verse]
'git stage' <arg>...
[synopsis]
git stage <arg>...


DESCRIPTION
Expand Down
Loading
Loading