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

[JGIT PATCH 7/9] Include commonly used commands in main help output

From
Shawn O. Pearce <spearce@spearce.org>
Date
Jul 25, 2008, 19:46 UTC
Message-ID
<1217015167-4680-8-git-send-email-spearce@spearce.org>
In-Reply-To
<1217015167-4680-7-git-send-email-spearce@spearce.org>

If the main loop did not get a subcommand during parsing of the command line then we should offer up a list of commonly used commands and their one-line usage summary, to help the user make a decision about which command they should try to execute.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---
 .../src/org/spearce/jgit/pgm/Main.java             |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
index c069989..c8bade8 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
@@ -121,6 +121,24 @@ public class Main {
 				System.err.println();
 				clp.printUsage(System.err);
 				System.err.println();
+			} else if (subcommand == null) {
+				System.err.println();
+				System.err.println("The most commonly used commands are:");
+				final CommandRef[] common = CommandCatalog.common();
+				int width = 0;
+				for (final CommandRef c : common)
+					width = Math.max(width, c.getName().length());
+				width += 2;
+
+				for (final CommandRef c : common) {
+					System.err.print(' ');
+					System.err.print(c.getName());
+					for (int i = c.getName().length(); i < width; i++)
+						System.err.print(' ');
+					System.err.print(c.getUsage());
+					System.err.println();
+				}
+				System.err.println();
 			}
 			System.exit(1);
 		}
-- 
1.6.0.rc0.182.gb96c7
Previous: Shawn O. PearceNext: Shawn O. Pearce
Message 8 of 12 in “List commonly used (or recognized) commands”
  1. 0/9 List commonly used (or recognized) commandsShawn O. Pearce, Jul 25, 2008
  2. 1/9 Switch jgit.pgm to J2SE-1.5 execution environmentShawn O. Pearce, Jul 25, 2008
  3. 2/9 Remove unnecessary duplicate if (help) test inside TextBuiltinShawn O. Pearce, Jul 25, 2008
  4. 3/9 Create an optional documentation annotation for TextBuiltinShawn O. Pearce, Jul 25, 2008
  5. 4/9 Create a lightweight registration wrapper for TextBuiltinShawn O. Pearce, Jul 25, 2008
  6. 5/9 Create a catalog of CommandRefs for lookup and enumerationShawn O. Pearce, Jul 25, 2008
  7. 6/9 Document some common commands with the new Command annotationShawn O. Pearce, Jul 25, 2008
  8. 7/9 Include commonly used commands in main help outputShawn O. Pearce, Jul 25, 2008
  9. 8/9 Refactor SubcommandHandler to use CommandCatalog instead of reflectionShawn O. Pearce, Jul 25, 2008
  10. 9/9 Add debug-show-commands to display the command tableShawn O. Pearce, Jul 25, 2008
  11. 5/9 Create a catalog of CommandRefs for lookup and enumerationShawn O. Pearce, Jul 25, 2008
  12. Shawn O. PearceJul 25, 2008

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.