From: martin f. krafft <madduck@debian.org>
Date: Thu, 20 Nov 2008 14:24:16 +0000 (+0100)
Subject: Note that do_help is used when short messages might be wanted
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=topgit.git;a=commitdiff_plain;h=10318b81d3a3b8b9cdccdc11b6bdc7ba907dac2c;hp=e788f47b677d5814289d9af5c037e3e8ff730da7

Note that do_help is used when short messages might be wanted

From http://marc.info/?l=git&m=122718711327376&w=2, by Petr:

  Note that I think these changes are reasonable only as long as do_help
  is just a short two-line usage help; in the event we also implement a
  longer help, it certainly shouldn't be printed in these cases.

This commit adds a comment to the do_help function to remind us.

Signed-off-by: martin f. krafft <madduck@debian.org>
---

diff --git a/tg.sh b/tg.sh
index 4020527..1fe0115 100644
--- a/tg.sh
+++ b/tg.sh
@@ -209,6 +209,12 @@ switch_to_base()
 do_help()
 {
 	if [ -z "$1" ] ; then
+		# This is currently invoked in all kinds of circumstances,
+		# including when the user made a usage error. Should we end up
+		# providing more than a short help message, then we should
+		# differentiate.
+		# Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
+
 		## Build available commands list for help output
 
 		cmds=