From 7d4d6517a651ffb5fea2b99790a859e3ea10e394 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Tue, 15 Dec 2020 08:52:56 -0800
Subject: [PATCH] ;shake: commandtxts -> cmdhelp; note todos

---
 Shake.hs                               | 17 ++++++++++++-----
 hledger/Hledger/Cli/Commands/README.md |  2 +-
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Shake.hs b/Shake.hs
index e21ff53b9..50940cfa4 100755
--- a/Shake.hs
+++ b/Shake.hs
@@ -69,8 +69,8 @@ usage =
   ,"./Shake [help]           show this help"
   ,"./Shake setversion [VER] [PKGS] [--commit]"
   ,"                         update version strings from */.version (or VER)"
-  ,"./Shake commandtxts [--commit]"
-  ,"                         update usage texts for hledger CLI commands"
+  ,"./Shake cmdhelp [--commit]"
+  ,"                         update help text for hledger CLI commands"
   ,"./Shake manuals [--commit]"
   ,"                         update txt/man/info/web manuals for all packages"
   -- ,"./Shake webmanuals       update just the web manuals"
@@ -87,6 +87,13 @@ usage =
   ,"./Shake --help           list Shake's options (--color, --rebuild, etc.)"
   ,"Keep Shake option arguments adjacent to their flag."
   ]
+-- TODO
+--  setversion: update cabal files
+--  ,"./Shake releasebranch    create a new release branch, bump master to next dev version (.99)" 
+--  ,"./Shake majorversion     bump to the next major version project-wide, update affected files"
+--  ,"./Shake minorversion PKGS..  bump one or more packages to their next minor version project-wide, update affected files"
+--  ,"./Shake docs            update program docs: help, manuals, changelogs"
+--  ,"./Shake relnotes [PKGS]  finalise changelogs, create draft release notes"
 
 -- groff    = "groff -c" ++ " -Wall"  -- see "groff" below
 makeinfo = "makeinfo" ++ " --no-warn"  -- silence makeinfo warnings - comment out to see them
@@ -376,7 +383,7 @@ main = do
         deps <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
         need $ [src, commonm4, packagem4, tmpl] ++ deps
         when (dir=="hledger") $ need commandmds
-        cmd_ Shell sed "-i -e" ("'s/(_monthyear_}}, *)\\{\\{[^}]+/\\1{{"++mandate++"/;'") packagem4  -- XXX forces a rebuild every time
+        cmd_ Shell sed "-i -e" ("'s/(_monthyear_}}, *)\\{\\{[^}]+/\\1{{"++mandate++"/;'") packagem4  -- forces a rebuild, only when month has changed ?
         cmd Shell
           "m4 -P -DMAN -I" dir commonm4 packagem4 src "|"
           pandoc fromsrcmd "-s" "--template" tmpl
@@ -512,7 +519,7 @@ main = do
           cmd Shell gitcommit ("-m '"++msg++"' --") cabalfiles
 
       -- regenerate Hledger/Cli/Commands/*.txt from the .md source files for CLI help
-      phony "commandtxts" $ do
+      phony "cmdhelp" $ do
         need commandtxts
         when commit $ do
           let msg = ";update CLI usage texts"
@@ -642,7 +649,7 @@ main = do
       -- Update all that needs updating.
       phony "update" $ need [
          "cabalfiles"
-        ,"commandtxts"
+        ,"cmdhelp"
         ,"manuals"
         ,"changelogs"
         ]
diff --git a/hledger/Hledger/Cli/Commands/README.md b/hledger/Hledger/Cli/Commands/README.md
index 81477728e..82d34e65a 100644
--- a/hledger/Hledger/Cli/Commands/README.md
+++ b/hledger/Hledger/Cli/Commands/README.md
@@ -11,7 +11,7 @@ After changing md files, regenerating and committing the txt files is
 optional. If you don't do it, it will get done later (before release).
 It can be done by:
 
-    ./Shake commandtxts
+    ./Shake cmdhelp
 
 Or, by you can regenerate them while also building packages: