git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 1/3] git-shortlog.txt: reorder usages

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Mar 14, 2018, 21:34 UTC
Message-ID
<a8210328f4db27cc119178b33e9512f8fcbba35c.1521062188.git.martin.agren@gmail.com>
In-Reply-To
<cover.1521062188.git.martin.agren@gmail.com>

The first usage we give is the original one where, e.g., `git log` is piped through `git shortlog`. The description that follows reads the other way round, by first focusing on the general behavior, then ending with the behavior when reading from stdin.

It is also a tiny bit odd that what is probably the most common usage and the one a reader is probably looking for is not at the top of the list. Of course, it is only a two-item list, so it is not _that_ hard to find... The next commit will add the original usage to the usage string in builtin/shortlog.c, and it feels more natural to do so below the most common usage. To avoid being inconsistent, reorder these two usages here first.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-shortlog.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index ee6c5476c1..5e35ea18ac 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -8,8 +8,8 @@ git-shortlog - Summarize 'git log' output
 SYNOPSIS
 --------
 [verse]
-git log --pretty=short | 'git shortlog' [<options>]
 'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
+git log --pretty=short | 'git shortlog' [<options>]
 
 DESCRIPTION
 -----------
-- 
2.16.2.246.ga4ee44448f
Previous: Martin ÅgrenNext: Martin Ågren
Message 12 of 24 in “shortlog: do not accept revisions when run outside repo”
  1. 0/3 shortlog: do not accept revisions when run outside repoMartin Ågren, Mar 10, 2018
  2. 1/3 git-shortlog.txt: reorder usagesMartin Ågren, Mar 10, 2018
  3. Junio C HamanoMar 13, 2018
  4. 2/3 shortlog: add usage-string for stdin-readingMartin Ågren, Mar 10, 2018
  5. 3/3 shortlog: do not accept revisions when run outside repoMartin Ågren, Mar 10, 2018
  6. Jonathan NiederMar 13, 2018
  7. Martin ÅgrenMar 13, 2018
  8. Jonathan NiederMar 13, 2018
  9. Junio C HamanoMar 13, 2018
  10. Martin ÅgrenMar 14, 2018
  11. 0/3 shortlog: disallow left-over arguments outside repoMartin Ågren, Mar 14, 2018
  12. 1/3 git-shortlog.txt: reorder usagesMartin Ågren, Mar 14, 2018
  13. 2/3 shortlog: add usage-string for stdin-readingMartin Ågren, Mar 14, 2018
  14. 3/3 shortlog: disallow left-over arguments outside repoMartin Ågren, Mar 14, 2018
  15. Jeff KingMar 28, 2018
  16. Martin ÅgrenMar 28, 2018
  17. 0/4 doc: cleaning up instances of \--Martin Ågren, Apr 17, 2018
  18. 1/4 doc: convert \--option to --optionMartin Ågren, Apr 17, 2018
  19. 2/4 doc: convert [\--] to [--]Martin Ågren, Apr 17, 2018
  20. 3/4 git-[short]log.txt: unify quoted standalone --Martin Ågren, Apr 17, 2018
  21. 4/4 git-submodule.txt: quote usage in monospace, drop backslashMartin Ågren, Apr 17, 2018
  22. Junio C HamanoApr 18, 2018
  23. Jeff KingMay 10, 2018
  24. brian m. carlsonApr 19, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.