summaryrefslogtreecommitdiff
path: root/Types
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-03-25 10:23:05 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-03-25 10:23:05 -0400
commit70912c45d126b06fe52890e26040bbd180f4f3d8 (patch)
tree9a94f3474c5c8a1fe19d6b2caf38079d22cdc533 /Types
parent98e460ec24073856f0a8ace7f4d1b28761e0be76 (diff)
Group subcommands into sections in usage. Closes: #703797
Diffstat (limited to 'Types')
-rw-r--r--Types/Command.hs12
1 files changed, 10 insertions, 2 deletions
diff --git a/Types/Command.hs b/Types/Command.hs
index 1d64c16d1..1679dcbca 100644
--- a/Types/Command.hs
+++ b/Types/Command.hs
@@ -53,9 +53,9 @@ instance Eq CommandCheck where
instance Eq Command where
a == b = cmdname a == cmdname b
-{- Order commands by name -}
+{- Order commands by section and then by name -}
instance Ord Command where
- compare = comparing cmdname
+ compare = comparing (\c -> (cmdsection c, cmdname c))
{- The same sections are listed in doc/git-annex.mdwn -}
data CommandSection
@@ -66,3 +66,11 @@ data CommandSection
| SectionUtility
| SectionPlumbing
deriving (Eq, Ord, Enum, Bounded)
+
+descSection :: CommandSection -> String
+descSection SectionCommon = "Commonly used commands"
+descSection SectionSetup = "Repository setup commands"
+descSection SectionMaintenance = "Repository maintenance commands"
+descSection SectionQuery = "Query commands"
+descSection SectionUtility = "Utility commands"
+descSection SectionPlumbing = "Plumbing commands"