{"thread":{"id":"6656","subject":"[PATCH] Cleanup subcommand documentation for git-remote.","startedAt":"2007-02-04T04:02:59Z","lastAt":"2007-02-04T04:02:59Z","messageCount":1,"participants":["Shawn O. Pearce"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"33526","messageId":"20070204040259.GA16955@spearce.org","threadId":"6656","inReplyTo":null,"subject":"[PATCH] Cleanup subcommand documentation for git-remote.","fromName":"Shawn O. Pearce","fromEmail":"spearce@spearce.org","sentAt":"2007-02-04T04:02:59Z","receivedAt":"2007-02-04T04:02:59Z","isPatch":true,"sender":{"key":"spearce@spearce.org","avatar":"https://avatars.githubusercontent.com/u/34844?v=4"},"body":"Jakub Narebski pointed out the positional notation in git-remote's\ndocumentation was very confusing, especially now that we have 3\nsupported subcommands.  Instead of referring to subcommands by\nposition, refer to them by name.\n\nSigned-off-by: Shawn O. Pearce <spearce@spearce.org>\n---\n Documentation/git-remote.txt |   23 +++++++++++++++++++----\n 1 files changed, 19 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt\nindex 817651e..a60c31a 100644\n--- a/Documentation/git-remote.txt\n+++ b/Documentation/git-remote.txt\n@@ -19,18 +19,33 @@ DESCRIPTION\n \n Manage the set of repositories (\"remotes\") whose branches you track.\n \n-With no arguments, shows a list of existing remotes.\n \n-In the second form, adds a remote named <name> for the repository at\n+COMMANDS\n+--------\n+\n+With no arguments, shows a list of existing remotes.  Several\n+subcommands are available to perform operations on the remotes.\n+\n+'add'::\n+\n+Adds a remote named <name> for the repository at\n <url>.  The command `git fetch <name>` can then be used to create and\n update remote-tracking branches <name>/<branch>.\n \n-In the third form, gives some information about the remote <name>.\n+'show'::\n \n-In the fourth form, deletes all stale tracking branches under <name>.\n+Gives some information about the remote <name>.\n+\n+'prune'::\n+\n+Deletes all stale tracking branches under <name>.\n These stale branches have already been removed from the remote repository\n referenced by <name>, but are still locally available in \"remotes/<name>\".\n \n+\n+DISCUSSION\n+----------\n+\n The remote configuration is achieved using the `remote.origin.url` and\n `remote.origin.fetch` configuration variables.  (See\n gitlink:git-config[1]).\n-- \n1.5.0.rc3.22.g5057\n"}]}