@matheusbsbs / matheus-bagliano / commits / 0f39087589
Fork 0

Cleanup subcommand documentation for git-remote.

Jakub Narebski pointed out the positional notation in git-remote's documentation was very confusing, especially now that we have 3 supported subcommands. Instead of referring to subcommands by position, refer to them by name. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>

Shawn O. Pearce committed Feb 3, 2007 at 23:02 UTC 0f3908758947b2279f5d2d4a294653d76a62d468
1 file changed +19 -4
Documentation/git-remote.txt
+19 -4
@@ -19,18 +19,33 @@ DESCRIPTION
19
20 Manage the set of repositories ("remotes") whose branches you track.
21
22 -With no arguments, shows a list of existing remotes.
22
24 -In the second form, adds a remote named <name> for the repository at
23 +COMMANDS
24 +--------
25 +
26 +With no arguments, shows a list of existing remotes. Several
27 +subcommands are available to perform operations on the remotes.
28 +
29 +'add'::
30 +
31 +Adds a remote named <name> for the repository at
32 <url>. The command `git fetch <name>` can then be used to create and
33 update remote-tracking branches <name>/<branch>.
34
28 -In the third form, gives some information about the remote <name>.
35 +'show'::
36
30 -In the fourth form, deletes all stale tracking branches under <name>.
37 +Gives some information about the remote <name>.
38 +
39 +'prune'::
40 +
41 +Deletes all stale tracking branches under <name>.
42 These stale branches have already been removed from the remote repository
43 referenced by <name>, but are still locally available in "remotes/<name>".
44
45 +
46 +DISCUSSION
47 +----------
48 +
49 The remote configuration is achieved using the `remote.origin.url` and
50 `remote.origin.fetch` configuration variables. (See
51 gitlink:git-config[1]).