slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

shake: update help, clean/Clean output

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-02-01 10:19:12 -08:00
parent 89bb4816c6
commit f1d4b39146
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Shake.hs
View File

@ -57,23 +57,25 @@ import "time" Data.Time
-- import "hledger-lib" Hledger.Utils.Debug -- import "hledger-lib" Hledger.Utils.Debug
usage = unlines usage = unlines
---------------------------------------79--------------------------------------
["Usage:" ["Usage:"
,"./Shake.hs # compile this script" ,"./Shake.hs (re)compile this script"
,"./Shake manuals # generate the txt/man/info manuals" ,"./Shake commandhelp build embedded help texts for the hledger CLI"
,"./Shake website # generate the website and web manuals" ,"./Shake manuals build embedded txt/man/info manuals for all packages"
,"./Shake commandhelp # generate the help text for hledger commands" ,"./Shake PKG build a single hledger package and its embedded docs"
,"./Shake PKG # build the specified hledger package, with awareness of embedded docs" ,"./Shake build build all hledger packages and their embedded docs"
,"./Shake build # build all hledger packages, with awareness of embedded docs" ,"./Shake website build the website and web manuals"
,"./Shake all # generate everything" ,"./Shake all build all the above"
,"" ,""
,"./Shake changelogs # update the changelogs with any new commits" ,"./Shake FILE build any individual file"
,"./Shake site/doc/VERSION/.snapshot # save the checked-out web manuals as a versioned snapshot" ,"./Shake changelogs update the changelogs with any new commits"
,"./Shake FILE # build any individual file" ,"./Shake [PKG/]CHANGES.md[-dry] update or preview this changelog"
,"./Shake clean # clean generated files" ,"./Shake site/doc/VERSION/.snapshot save current web manuals as this snapshot"
,"./Shake Clean # clean more thoroughly, including Shake's dependency cache"
,"" ,""
,"./Shake [help] # show commands" ,"./Shake clean clean help texts, manuals, staged site content"
,"./Shake --help # show detailed Shake options, eg --color" ,"./Shake Clean also clean rendered site, object files, Shake's cache"
,"./Shake [help] show these commands"
,"./Shake --help show Shake options (--color, --rebuild, ...)"
] ]
groff = "groff" groff = "groff"
@ -482,7 +484,7 @@ main = do
cmd Shell "touch" out -- :: Action ExitCode cmd Shell "touch" out -- :: Action ExitCode
phony "clean" $ do phony "clean" $ do
putNormal "Cleaning generated files" putNormal "Cleaning generated help texts, manuals, staged site content"
removeFilesAfter "." commandtxts removeFilesAfter "." commandtxts
removeFilesAfter "." webmanuals removeFilesAfter "." webmanuals
removeFilesAfter "." [webmancombined] removeFilesAfter "." [webmancombined]
@ -490,12 +492,10 @@ main = do
phony "Clean" $ do phony "Clean" $ do
need ["clean"] need ["clean"]
putNormal "Cleaning all site generated files" putNormal "Cleaning generated site content, object files, shake build cache"
removeFilesAfter "site" ["_*"] removeFilesAfter "site" ["_*"]
putNormal "Cleaning object files" -- also forces rebuild of executables
removeFilesAfter "tools" ["*.o","*.p_o","*.hi"] removeFilesAfter "tools" ["*.o","*.p_o","*.hi"]
removeFilesAfter "site" ["*.o","*.p_o","*.hi"] removeFilesAfter "site" ["*.o","*.p_o","*.hi"]
putNormal "Cleaning shake build files"
removeFilesAfter ".shake" ["//*"] removeFilesAfter ".shake" ["//*"]