diff --git a/Makefile b/Makefile index 62449d81b..22f84cb77 100644 --- a/Makefile +++ b/Makefile @@ -150,10 +150,10 @@ CABALFILES:= \ MANUALSOURCEFILES:= \ doc/lib.m4 \ - */*/*.m4.md \ + */*.m4.md \ MANUALGENFILES:= \ - hledger*/doc/hledger*.[15]{,.info,.txt} \ + hledger*/hledger*.{1,5,info,txt} \ # site/*.md includes website source files and generated web manual files # WEBDOCFILES:= \ @@ -1399,8 +1399,8 @@ genmanuals: Shake #$(call def-help,genmanuals, regenerate embedded manuals (migh ./Shake manuals updatemanuals: genmanuals $(call def-help,updatemanuals, regenerate embedded manuals and commit (might need -B) ) - @read -p "please review changes then press enter to commit: $(shell ls hledger*/doc/*.[15]*)" - git commit -m "update embedded manuals" hledger*/doc/*.[15]* + @read -p "please review changes then press enter to commit: $(shell ls hledger*/hledger*.{1,5,info,txt})" + git commit -m "update embedded manuals" hledger*/hledger*.{1,5,info,txt} tagrelease: \ diff --git a/Shake.hs b/Shake.hs index 31d28d592..f3295511c 100755 --- a/Shake.hs +++ b/Shake.hs @@ -112,17 +112,33 @@ main = do ,"hledger_timeclock.5" ,"hledger_timedot.5" ] - -- manuals m4 source, may include other files (hledger/doc/hledger.1.m4.md) - m4manpages = [manpageDir m m <.> "m4.md" | m <- manpageNames] - -- manuals rendered to nroff, ready for man (hledger/doc/hledger.1) + manualNames = map manpageNameToManualName manpageNames + + -- hledger.1 -> hledger, hledger_journal.5 -> hledger_journal + manpageNameToManualName = dropNumericSuffix + where + dropNumericSuffix s = reverse $ + case reverse s of + c : '.' : cs | isDigit c -> cs + cs -> cs + + -- hledger -> hledger.1, hledger_journal -> hledger_journal.5 + manualNameToManpageName s + | '_' `elem` s = s <.> "5" + | otherwise = s <.> "1" + + -- manuals m4 source; may include other source files (hledger/hledger.m4.md) + m4manpages = [manualDir m m <.> "m4.md" | m <- manualNames] + + -- manuals rendered to nroff, ready for man (hledger/hledger.1) nroffmanpages = [manpageDir m m | m <- manpageNames] - -- manuals rendered to text, ready for embedding (hledger/doc/hledger.1.txt) - txtmanpages = [manpageDir m m <.> "txt" | m <- manpageNames] + -- manuals rendered to text, ready for embedding (hledger/hledger.txt) + txtmanpages = [manualDir m m <.> "txt" | m <- manualNames] - -- manuals rendered to info, ready for info (hledger/doc/hledger.1.info) - infomanpages = [manpageDir m m <.> "info" | m <- manpageNames] + -- manuals rendered to info, ready for info (hledger/hledger.info) + infomanpages = [manualDir m m <.> "info" | m <- manualNames] -- manuals rendered to markdown, ready for web output by hakyll (site/hledger.md) webmanpages = ["site" manpageNameToUri m <.>"md" | m <- manpageNames] @@ -154,8 +170,13 @@ main = do -- hledger.1 -> hledger/doc, hledger_journal.5 -> hledger-lib/doc manpageDir m - | '_' `elem` m = "hledger-lib" "doc" - | otherwise = dropExtension m "doc" + | '_' `elem` m = "hledger-lib" + | otherwise = dropExtension m + + -- hledger -> hledger, hledger_journal -> hledger-lib + manualDir m + | '_' `elem` m = "hledger-lib" + | otherwise = m -- hledger.1 -> hledger, hledger_journal.5 -> journal manpageNameToUri m | "hledger_" `isPrefixOf` m = dropExtension $ drop 8 m @@ -183,8 +204,8 @@ main = do -- use m4 and pandoc to process macros, filter content, and convert to nroff suitable for man output phony "manpages" $ need nroffmanpages - nroffmanpages |%> \out -> do -- hledger/doc/hledger.1 - let src = out <.> "m4.md" + nroffmanpages |%> \out -> do -- hledger/hledger.1 + let src = manpageNameToManualName out <.> "m4.md" lib = "doc/lib.m4" dir = takeDirectory out tmpl = "doc/manpage.nroff" @@ -204,15 +225,15 @@ main = do -- render man page nroffs to fixed-width text for embedding in executables, with nroff phony "txtmanpages" $ need txtmanpages - txtmanpages |%> \out -> do -- hledger/doc/hledger.1.txt - let src = dropExtension out + txtmanpages |%> \out -> do -- hledger/hledger.txt + let src = dropExtension out <.> "m4.md" need [src] cmd Shell groff "-t -e -mandoc -Tascii" src "| col -bx >" out -- http://www.tldp.org/HOWTO/Man-Page/q10.html -- use m4 and pandoc to process macros, filter content, and convert to info, suitable for info viewing phony "infomanpages" $ need infomanpages - infomanpages |%> \out -> do -- hledger/doc/hledger.1.info + infomanpages |%> \out -> do -- hledger/hledger.info let src = out -<.> "m4.md" lib = "doc/lib.m4" dir = takeDirectory out @@ -249,11 +270,12 @@ main = do phony "webmanpages" $ need webmanpages webmanpages |%> \out -> do -- site/hledger.md - let m = manpageUriToName $ dropExtension $ takeFileName out -- hledger.1 - dir = manpageDir m - src = dir m <.> "m4.md" + let manpage = manpageUriToName $ dropExtension $ takeFileName out -- hledger + manual = manpageNameToManualName manpage + dir = manpageDir manpage + src = dir manual <.> "m4.md" lib = "doc/lib.m4" - heading = let h = dropExtension m + heading = let h = manual in if "hledger_" `isPrefixOf` h then drop 8 h ++ " format" else h diff --git a/doc/README b/doc/README index 0da37196d..704dea531 100644 --- a/doc/README +++ b/doc/README @@ -24,7 +24,7 @@ These are in the respective package directories: hledger*/package.yaml source for package metadata (description, etc.) hledger*/README package readme, displayed on hackage hledger*/CHANGES package changelog, displayed on hackage -hledger*/doc/hledger*.m4.md package manual source file(s) +hledger*/hledger*.m4.md package manual source file(s) 4. The project website and additional docs - home page, FAQ, tutorials, how-tos, developer guide, etc. These are in the site directory: @@ -45,12 +45,17 @@ such as m4: $ ./Shake manuals -Then render the website. This copies the manuals' markdown files into -the website, edits them for web display, concatenates them to form the -one-page manual, and runs hakyll-std (a generic hakyll script, included) -to render everything as html and add site header/footer, -tables of contents, etc.: - +The text/man/info manuals are embedded in the hledger executable, so a +rebuild of that now will pick up the latest manuals: + +$ stack build hledger + +The website uses the markdown manuals. This copies them into the +website, edits them for web display, concatenates them to form the +one-page manual, and runs hakyll-std (a generic hakyll script, +included) which adds tables of contents and renders everything as html +with the site header/footer. + $ ./Shake website View the rendered website ("open" is mac-specific; use your equivalent): diff --git a/hledger-api/doc/README b/hledger-api/doc/README deleted file mode 100644 index 0b8691b7f..000000000 --- a/hledger-api/doc/README +++ /dev/null @@ -1,2 +0,0 @@ -Documentation for this package, used to generate manual(s) in multiple -formats (see Shake.hs). *.m4.md are the master files. diff --git a/hledger-api/doc/hledger-api.1 b/hledger-api/hledger-api.1 similarity index 100% rename from hledger-api/doc/hledger-api.1 rename to hledger-api/hledger-api.1 diff --git a/hledger-api/hledger-api.cabal b/hledger-api/hledger-api.cabal index 963553be6..2a79b25e2 100644 --- a/hledger-api/hledger-api.cabal +++ b/hledger-api/hledger-api.cabal @@ -33,9 +33,9 @@ extra-source-files: README data-files: - doc/hledger-api.1 - doc/hledger-api.1.info - doc/hledger-api.1.txt + hledger-api.1 + hledger-api.info + hledger-api.txt source-repository head type: git diff --git a/hledger-api/doc/hledger-api.1.info b/hledger-api/hledger-api.info similarity index 100% rename from hledger-api/doc/hledger-api.1.info rename to hledger-api/hledger-api.info diff --git a/hledger-api/doc/hledger-api.1.m4.md b/hledger-api/hledger-api.m4.md similarity index 100% rename from hledger-api/doc/hledger-api.1.m4.md rename to hledger-api/hledger-api.m4.md diff --git a/hledger-api/doc/hledger-api.1.txt b/hledger-api/hledger-api.txt similarity index 100% rename from hledger-api/doc/hledger-api.1.txt rename to hledger-api/hledger-api.txt diff --git a/hledger-api/package.yaml b/hledger-api/package.yaml index e737467f3..2ed1fc0d1 100644 --- a/hledger-api/package.yaml +++ b/hledger-api/package.yaml @@ -27,9 +27,9 @@ extra-source-files: - examples/*.html data-files: -- doc/hledger-api.1 -- doc/hledger-api.1.txt -- doc/hledger-api.1.info +- hledger-api.1 +- hledger-api.txt +- hledger-api.info dependencies: - hledger-lib >= 1.4 && < 1.5 diff --git a/hledger-lib/doc/README b/hledger-lib/doc/README deleted file mode 100644 index 0b8691b7f..000000000 --- a/hledger-lib/doc/README +++ /dev/null @@ -1,2 +0,0 @@ -Documentation for this package, used to generate manual(s) in multiple -formats (see Shake.hs). *.m4.md are the master files. diff --git a/hledger-lib/hledger-lib.cabal b/hledger-lib/hledger-lib.cabal index 8b7f7393b..31d7e3fcd 100644 --- a/hledger-lib/hledger-lib.cabal +++ b/hledger-lib/hledger-lib.cabal @@ -30,18 +30,18 @@ extra-source-files: README data-files: - doc/hledger_csv.5 - doc/hledger_csv.5.info - doc/hledger_csv.5.txt - doc/hledger_journal.5 - doc/hledger_journal.5.info - doc/hledger_journal.5.txt - doc/hledger_timeclock.5 - doc/hledger_timeclock.5.info - doc/hledger_timeclock.5.txt - doc/hledger_timedot.5 - doc/hledger_timedot.5.info - doc/hledger_timedot.5.txt + hledger_csv.5 + hledger_csv.info + hledger_csv.txt + hledger_journal.5 + hledger_journal.info + hledger_journal.txt + hledger_timeclock.5 + hledger_timeclock.info + hledger_timeclock.txt + hledger_timedot.5 + hledger_timedot.info + hledger_timedot.txt source-repository head type: git diff --git a/hledger-lib/doc/hledger_csv.5 b/hledger-lib/hledger_csv.5 similarity index 100% rename from hledger-lib/doc/hledger_csv.5 rename to hledger-lib/hledger_csv.5 diff --git a/hledger-lib/doc/hledger_csv.5.info b/hledger-lib/hledger_csv.info similarity index 100% rename from hledger-lib/doc/hledger_csv.5.info rename to hledger-lib/hledger_csv.info diff --git a/hledger-lib/doc/hledger_csv.5.m4.md b/hledger-lib/hledger_csv.m4.md similarity index 100% rename from hledger-lib/doc/hledger_csv.5.m4.md rename to hledger-lib/hledger_csv.m4.md diff --git a/hledger-lib/doc/hledger_csv.5.txt b/hledger-lib/hledger_csv.txt similarity index 100% rename from hledger-lib/doc/hledger_csv.5.txt rename to hledger-lib/hledger_csv.txt diff --git a/hledger-lib/doc/hledger_journal.5 b/hledger-lib/hledger_journal.5 similarity index 100% rename from hledger-lib/doc/hledger_journal.5 rename to hledger-lib/hledger_journal.5 diff --git a/hledger-lib/doc/hledger_journal.5.info b/hledger-lib/hledger_journal.info similarity index 100% rename from hledger-lib/doc/hledger_journal.5.info rename to hledger-lib/hledger_journal.info diff --git a/hledger-lib/doc/hledger_journal.5.m4.md b/hledger-lib/hledger_journal.m4.md similarity index 100% rename from hledger-lib/doc/hledger_journal.5.m4.md rename to hledger-lib/hledger_journal.m4.md diff --git a/hledger-lib/doc/hledger_journal.5.txt b/hledger-lib/hledger_journal.txt similarity index 100% rename from hledger-lib/doc/hledger_journal.5.txt rename to hledger-lib/hledger_journal.txt diff --git a/hledger-lib/doc/hledger_timeclock.5 b/hledger-lib/hledger_timeclock.5 similarity index 100% rename from hledger-lib/doc/hledger_timeclock.5 rename to hledger-lib/hledger_timeclock.5 diff --git a/hledger-lib/doc/hledger_timeclock.5.info b/hledger-lib/hledger_timeclock.info similarity index 100% rename from hledger-lib/doc/hledger_timeclock.5.info rename to hledger-lib/hledger_timeclock.info diff --git a/hledger-lib/doc/hledger_timeclock.5.m4.md b/hledger-lib/hledger_timeclock.m4.md similarity index 100% rename from hledger-lib/doc/hledger_timeclock.5.m4.md rename to hledger-lib/hledger_timeclock.m4.md diff --git a/hledger-lib/doc/hledger_timeclock.5.txt b/hledger-lib/hledger_timeclock.txt similarity index 100% rename from hledger-lib/doc/hledger_timeclock.5.txt rename to hledger-lib/hledger_timeclock.txt diff --git a/hledger-lib/doc/hledger_timedot.5 b/hledger-lib/hledger_timedot.5 similarity index 100% rename from hledger-lib/doc/hledger_timedot.5 rename to hledger-lib/hledger_timedot.5 diff --git a/hledger-lib/doc/hledger_timedot.5.info b/hledger-lib/hledger_timedot.info similarity index 100% rename from hledger-lib/doc/hledger_timedot.5.info rename to hledger-lib/hledger_timedot.info diff --git a/hledger-lib/doc/hledger_timedot.5.m4.md b/hledger-lib/hledger_timedot.m4.md similarity index 100% rename from hledger-lib/doc/hledger_timedot.5.m4.md rename to hledger-lib/hledger_timedot.m4.md diff --git a/hledger-lib/doc/hledger_timedot.5.txt b/hledger-lib/hledger_timedot.txt similarity index 100% rename from hledger-lib/doc/hledger_timedot.5.txt rename to hledger-lib/hledger_timedot.txt diff --git a/hledger-lib/package.yaml b/hledger-lib/package.yaml index ab26e46f6..a2be11c0a 100644 --- a/hledger-lib/package.yaml +++ b/hledger-lib/package.yaml @@ -25,18 +25,18 @@ extra-source-files: - README data-files: -- doc/hledger_csv.5 -- doc/hledger_csv.5.txt -- doc/hledger_csv.5.info -- doc/hledger_journal.5 -- doc/hledger_journal.5.txt -- doc/hledger_journal.5.info -- doc/hledger_timedot.5 -- doc/hledger_timedot.5.txt -- doc/hledger_timedot.5.info -- doc/hledger_timeclock.5 -- doc/hledger_timeclock.5.txt -- doc/hledger_timeclock.5.info +- hledger_csv.5 +- hledger_csv.txt +- hledger_csv.info +- hledger_journal.5 +- hledger_journal.txt +- hledger_journal.info +- hledger_timedot.5 +- hledger_timedot.txt +- hledger_timedot.info +- hledger_timeclock.5 +- hledger_timeclock.txt +- hledger_timeclock.info dependencies: - base >=4.8 && <5 diff --git a/hledger-ui/doc/README b/hledger-ui/doc/README deleted file mode 100644 index 0b8691b7f..000000000 --- a/hledger-ui/doc/README +++ /dev/null @@ -1,2 +0,0 @@ -Documentation for this package, used to generate manual(s) in multiple -formats (see Shake.hs). *.m4.md are the master files. diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/hledger-ui.1 similarity index 100% rename from hledger-ui/doc/hledger-ui.1 rename to hledger-ui/hledger-ui.1 diff --git a/hledger-ui/hledger-ui.cabal b/hledger-ui/hledger-ui.cabal index b94c1183d..151d8bea1 100644 --- a/hledger-ui/hledger-ui.cabal +++ b/hledger-ui/hledger-ui.cabal @@ -32,9 +32,9 @@ extra-source-files: README data-files: - doc/hledger-ui.1 - doc/hledger-ui.1.info - doc/hledger-ui.1.txt + hledger-ui.1 + hledger-ui.info + hledger-ui.txt source-repository head type: git diff --git a/hledger-ui/doc/hledger-ui.1.info b/hledger-ui/hledger-ui.info similarity index 100% rename from hledger-ui/doc/hledger-ui.1.info rename to hledger-ui/hledger-ui.info diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/hledger-ui.m4.md similarity index 100% rename from hledger-ui/doc/hledger-ui.1.m4.md rename to hledger-ui/hledger-ui.m4.md diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/hledger-ui.txt similarity index 100% rename from hledger-ui/doc/hledger-ui.1.txt rename to hledger-ui/hledger-ui.txt diff --git a/hledger-ui/package.yaml b/hledger-ui/package.yaml index 33fa3b548..890ee813e 100644 --- a/hledger-ui/package.yaml +++ b/hledger-ui/package.yaml @@ -27,9 +27,9 @@ extra-source-files: - README data-files: - - doc/hledger-ui.1 - - doc/hledger-ui.1.txt - - doc/hledger-ui.1.info + - hledger-ui.1 + - hledger-ui.txt + - hledger-ui.info flags: threaded: diff --git a/hledger-web/doc/README b/hledger-web/doc/README deleted file mode 100644 index 0b8691b7f..000000000 --- a/hledger-web/doc/README +++ /dev/null @@ -1,2 +0,0 @@ -Documentation for this package, used to generate manual(s) in multiple -formats (see Shake.hs). *.m4.md are the master files. diff --git a/hledger-web/doc/hledger-web.1 b/hledger-web/hledger-web.1 similarity index 100% rename from hledger-web/doc/hledger-web.1 rename to hledger-web/hledger-web.1 diff --git a/hledger-web/hledger-web.cabal b/hledger-web/hledger-web.cabal index 9cd392d12..6cf94801d 100644 --- a/hledger-web/hledger-web.cabal +++ b/hledger-web/hledger-web.cabal @@ -95,9 +95,9 @@ extra-source-files: templates/default-layout.hamlet data-files: - doc/hledger-web.1 - doc/hledger-web.1.info - doc/hledger-web.1.txt + hledger-web.1 + hledger-web.info + hledger-web.txt source-repository head type: git diff --git a/hledger-web/doc/hledger-web.1.info b/hledger-web/hledger-web.info similarity index 100% rename from hledger-web/doc/hledger-web.1.info rename to hledger-web/hledger-web.info diff --git a/hledger-web/doc/hledger-web.1.m4.md b/hledger-web/hledger-web.m4.md similarity index 100% rename from hledger-web/doc/hledger-web.1.m4.md rename to hledger-web/hledger-web.m4.md diff --git a/hledger-web/doc/hledger-web.1.txt b/hledger-web/hledger-web.txt similarity index 100% rename from hledger-web/doc/hledger-web.1.txt rename to hledger-web/hledger-web.txt diff --git a/hledger-web/package.yaml b/hledger-web/package.yaml index 83810bf13..f20517bfb 100644 --- a/hledger-web/package.yaml +++ b/hledger-web/package.yaml @@ -43,9 +43,9 @@ extra-source-files: - templates/*.hamlet data-files: -- doc/hledger-web.1 -- doc/hledger-web.1.txt -- doc/hledger-web.1.info +- hledger-web.1 +- hledger-web.txt +- hledger-web.info flags: library-only: diff --git a/hledger/doc/other/README b/hledger/.otherdocs/README similarity index 71% rename from hledger/doc/other/README rename to hledger/.otherdocs/README index e01a061c2..f6d5956cf 100644 --- a/hledger/doc/other/README +++ b/hledger/.otherdocs/README @@ -1,4 +1,4 @@ -A local copy of all the other hledger packages' rendered manuals, +Symbolic links to all the other hledger packages' rendered manuals, for embedding into the hledger program via Hledger/Cli/DocFiles.hs. (Because you can only embed relative file paths which are under the current package directory, IIRC). diff --git a/hledger/.otherdocs/hledger-api.1 b/hledger/.otherdocs/hledger-api.1 new file mode 120000 index 000000000..bafa629c8 --- /dev/null +++ b/hledger/.otherdocs/hledger-api.1 @@ -0,0 +1 @@ +../../hledger-api/hledger-api.1 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-api.info b/hledger/.otherdocs/hledger-api.info new file mode 120000 index 000000000..7d4b9c3f1 --- /dev/null +++ b/hledger/.otherdocs/hledger-api.info @@ -0,0 +1 @@ +../../hledger-api/hledger-api.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-api.txt b/hledger/.otherdocs/hledger-api.txt new file mode 120000 index 000000000..d00f9ec9a --- /dev/null +++ b/hledger/.otherdocs/hledger-api.txt @@ -0,0 +1 @@ +../../hledger-api/hledger-api.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-ui.1 b/hledger/.otherdocs/hledger-ui.1 new file mode 120000 index 000000000..172714a72 --- /dev/null +++ b/hledger/.otherdocs/hledger-ui.1 @@ -0,0 +1 @@ +../../hledger-ui/hledger-ui.1 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-ui.info b/hledger/.otherdocs/hledger-ui.info new file mode 120000 index 000000000..7ce58155b --- /dev/null +++ b/hledger/.otherdocs/hledger-ui.info @@ -0,0 +1 @@ +../../hledger-ui/hledger-ui.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-ui.txt b/hledger/.otherdocs/hledger-ui.txt new file mode 120000 index 000000000..97e5b31d9 --- /dev/null +++ b/hledger/.otherdocs/hledger-ui.txt @@ -0,0 +1 @@ +../../hledger-ui/hledger-ui.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-web.1 b/hledger/.otherdocs/hledger-web.1 new file mode 120000 index 000000000..56fa56b5b --- /dev/null +++ b/hledger/.otherdocs/hledger-web.1 @@ -0,0 +1 @@ +../../hledger-web/hledger-web.1 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-web.info b/hledger/.otherdocs/hledger-web.info new file mode 120000 index 000000000..adc31deb0 --- /dev/null +++ b/hledger/.otherdocs/hledger-web.info @@ -0,0 +1 @@ +../../hledger-web/hledger-web.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger-web.txt b/hledger/.otherdocs/hledger-web.txt new file mode 120000 index 000000000..3e423b3ba --- /dev/null +++ b/hledger/.otherdocs/hledger-web.txt @@ -0,0 +1 @@ +../../hledger-web/hledger-web.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_csv.5 b/hledger/.otherdocs/hledger_csv.5 new file mode 120000 index 000000000..1e5006ccd --- /dev/null +++ b/hledger/.otherdocs/hledger_csv.5 @@ -0,0 +1 @@ +../../hledger-lib/hledger_csv.5 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_csv.info b/hledger/.otherdocs/hledger_csv.info new file mode 120000 index 000000000..0a56521c3 --- /dev/null +++ b/hledger/.otherdocs/hledger_csv.info @@ -0,0 +1 @@ +../../hledger-lib/hledger_csv.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_csv.txt b/hledger/.otherdocs/hledger_csv.txt new file mode 120000 index 000000000..3e3b5c0a3 --- /dev/null +++ b/hledger/.otherdocs/hledger_csv.txt @@ -0,0 +1 @@ +../../hledger-lib/hledger_csv.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_journal.5 b/hledger/.otherdocs/hledger_journal.5 new file mode 120000 index 000000000..b2d330d11 --- /dev/null +++ b/hledger/.otherdocs/hledger_journal.5 @@ -0,0 +1 @@ +../../hledger-lib/hledger_journal.5 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_journal.info b/hledger/.otherdocs/hledger_journal.info new file mode 120000 index 000000000..1bf9759e9 --- /dev/null +++ b/hledger/.otherdocs/hledger_journal.info @@ -0,0 +1 @@ +../../hledger-lib/hledger_journal.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_journal.txt b/hledger/.otherdocs/hledger_journal.txt new file mode 120000 index 000000000..5d84ac23d --- /dev/null +++ b/hledger/.otherdocs/hledger_journal.txt @@ -0,0 +1 @@ +../../hledger-lib/hledger_journal.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timeclock.5 b/hledger/.otherdocs/hledger_timeclock.5 new file mode 120000 index 000000000..076e3541d --- /dev/null +++ b/hledger/.otherdocs/hledger_timeclock.5 @@ -0,0 +1 @@ +../../hledger-lib/hledger_timeclock.5 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timeclock.info b/hledger/.otherdocs/hledger_timeclock.info new file mode 120000 index 000000000..d5c447eff --- /dev/null +++ b/hledger/.otherdocs/hledger_timeclock.info @@ -0,0 +1 @@ +../../hledger-lib/hledger_timeclock.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timeclock.txt b/hledger/.otherdocs/hledger_timeclock.txt new file mode 120000 index 000000000..8cce85050 --- /dev/null +++ b/hledger/.otherdocs/hledger_timeclock.txt @@ -0,0 +1 @@ +../../hledger-lib/hledger_timeclock.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timedot.5 b/hledger/.otherdocs/hledger_timedot.5 new file mode 120000 index 000000000..bae523dfd --- /dev/null +++ b/hledger/.otherdocs/hledger_timedot.5 @@ -0,0 +1 @@ +../../hledger-lib/hledger_timedot.5 \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timedot.info b/hledger/.otherdocs/hledger_timedot.info new file mode 120000 index 000000000..1392717f3 --- /dev/null +++ b/hledger/.otherdocs/hledger_timedot.info @@ -0,0 +1 @@ +../../hledger-lib/hledger_timedot.info \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_timedot.txt b/hledger/.otherdocs/hledger_timedot.txt new file mode 120000 index 000000000..039b01139 --- /dev/null +++ b/hledger/.otherdocs/hledger_timedot.txt @@ -0,0 +1 @@ +../../hledger-lib/hledger_timedot.txt \ No newline at end of file diff --git a/hledger/Hledger/Cli/DocFiles.hs b/hledger/Hledger/Cli/DocFiles.hs index ac3cbc7cc..05c289a0b 100644 --- a/hledger/Hledger/Cli/DocFiles.hs +++ b/hledger/Hledger/Cli/DocFiles.hs @@ -35,44 +35,44 @@ type Topic = String docFiles :: IsString a => [(Topic, (a, a, a))] docFiles = [ ("hledger", - ($(makeRelativeToProject "doc/hledger.1" >>= embedStringFile) - ,$(makeRelativeToProject "doc/hledger.1.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/hledger.1.info" >>= embedStringFile) + ($(makeRelativeToProject "hledger.1" >>= embedStringFile) + ,$(makeRelativeToProject "hledger.txt" >>= embedStringFile) + ,$(makeRelativeToProject "hledger.info" >>= embedStringFile) )) ,("hledger-ui", - ($(makeRelativeToProject "doc/other/hledger-ui.1" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-ui.1.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-ui.1.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger-ui.1" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-ui.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-ui.info" >>= embedStringFile) )) ,("hledger-web", - ($(makeRelativeToProject "doc/other/hledger-web.1" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-web.1.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-web.1.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger-web.1" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-web.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-web.info" >>= embedStringFile) )) ,("hledger-api", - ($(makeRelativeToProject "doc/other/hledger-api.1" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-api.1.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger-api.1.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger-api.1" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-api.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger-api.info" >>= embedStringFile) )) ,("journal", - ($(makeRelativeToProject "doc/other/hledger_journal.5" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_journal.5.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_journal.5.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger_journal.5" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_journal.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_journal.info" >>= embedStringFile) )) ,("csv", - ($(makeRelativeToProject "doc/other/hledger_csv.5" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_csv.5.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_csv.5.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger_csv.5" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_csv.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_csv.info" >>= embedStringFile) )) ,("timeclock", - ($(makeRelativeToProject "doc/other/hledger_timeclock.5" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_timeclock.5.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_timeclock.5.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger_timeclock.5" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_timeclock.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_timeclock.info" >>= embedStringFile) )) ,("timedot", - ($(makeRelativeToProject "doc/other/hledger_timedot.5" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_timedot.5.txt" >>= embedStringFile) - ,$(makeRelativeToProject "doc/other/hledger_timedot.5.info" >>= embedStringFile) + ($(makeRelativeToProject ".otherdocs/hledger_timedot.5" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_timedot.txt" >>= embedStringFile) + ,$(makeRelativeToProject ".otherdocs/hledger_timedot.info" >>= embedStringFile) )) ] diff --git a/hledger/doc/README b/hledger/doc/README deleted file mode 100644 index 0b8691b7f..000000000 --- a/hledger/doc/README +++ /dev/null @@ -1,2 +0,0 @@ -Documentation for this package, used to generate manual(s) in multiple -formats (see Shake.hs). *.m4.md are the master files. diff --git a/hledger/doc/other/hledger-api.1 b/hledger/doc/other/hledger-api.1 deleted file mode 120000 index 112623610..000000000 --- a/hledger/doc/other/hledger-api.1 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-api/doc/hledger-api.1 \ No newline at end of file diff --git a/hledger/doc/other/hledger-api.1.info b/hledger/doc/other/hledger-api.1.info deleted file mode 120000 index 5e419823a..000000000 --- a/hledger/doc/other/hledger-api.1.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-api/doc/hledger-api.1.info \ No newline at end of file diff --git a/hledger/doc/other/hledger-api.1.txt b/hledger/doc/other/hledger-api.1.txt deleted file mode 120000 index 41482c65b..000000000 --- a/hledger/doc/other/hledger-api.1.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-api/doc/hledger-api.1.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger-ui.1 b/hledger/doc/other/hledger-ui.1 deleted file mode 120000 index c530a2fff..000000000 --- a/hledger/doc/other/hledger-ui.1 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-ui/doc/hledger-ui.1 \ No newline at end of file diff --git a/hledger/doc/other/hledger-ui.1.info b/hledger/doc/other/hledger-ui.1.info deleted file mode 120000 index 5501a8809..000000000 --- a/hledger/doc/other/hledger-ui.1.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-ui/doc/hledger-ui.1.info \ No newline at end of file diff --git a/hledger/doc/other/hledger-ui.1.txt b/hledger/doc/other/hledger-ui.1.txt deleted file mode 120000 index 774b30ede..000000000 --- a/hledger/doc/other/hledger-ui.1.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-ui/doc/hledger-ui.1.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger-web.1 b/hledger/doc/other/hledger-web.1 deleted file mode 120000 index 5987eef33..000000000 --- a/hledger/doc/other/hledger-web.1 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-web/doc/hledger-web.1 \ No newline at end of file diff --git a/hledger/doc/other/hledger-web.1.info b/hledger/doc/other/hledger-web.1.info deleted file mode 120000 index ebacd06b8..000000000 --- a/hledger/doc/other/hledger-web.1.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-web/doc/hledger-web.1.info \ No newline at end of file diff --git a/hledger/doc/other/hledger-web.1.txt b/hledger/doc/other/hledger-web.1.txt deleted file mode 120000 index bffd50e3c..000000000 --- a/hledger/doc/other/hledger-web.1.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-web/doc/hledger-web.1.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger_csv.5 b/hledger/doc/other/hledger_csv.5 deleted file mode 120000 index c7424acbc..000000000 --- a/hledger/doc/other/hledger_csv.5 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_csv.5 \ No newline at end of file diff --git a/hledger/doc/other/hledger_csv.5.info b/hledger/doc/other/hledger_csv.5.info deleted file mode 120000 index 01ff474af..000000000 --- a/hledger/doc/other/hledger_csv.5.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_csv.5.info \ No newline at end of file diff --git a/hledger/doc/other/hledger_csv.5.txt b/hledger/doc/other/hledger_csv.5.txt deleted file mode 120000 index 9cead72ba..000000000 --- a/hledger/doc/other/hledger_csv.5.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_csv.5.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger_journal.5 b/hledger/doc/other/hledger_journal.5 deleted file mode 120000 index 0842eb416..000000000 --- a/hledger/doc/other/hledger_journal.5 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_journal.5 \ No newline at end of file diff --git a/hledger/doc/other/hledger_journal.5.info b/hledger/doc/other/hledger_journal.5.info deleted file mode 120000 index 5d1e92bac..000000000 --- a/hledger/doc/other/hledger_journal.5.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_journal.5.info \ No newline at end of file diff --git a/hledger/doc/other/hledger_journal.5.txt b/hledger/doc/other/hledger_journal.5.txt deleted file mode 120000 index 244973395..000000000 --- a/hledger/doc/other/hledger_journal.5.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_journal.5.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger_timeclock.5 b/hledger/doc/other/hledger_timeclock.5 deleted file mode 120000 index 7fe8a4455..000000000 --- a/hledger/doc/other/hledger_timeclock.5 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timeclock.5 \ No newline at end of file diff --git a/hledger/doc/other/hledger_timeclock.5.info b/hledger/doc/other/hledger_timeclock.5.info deleted file mode 120000 index b1f159056..000000000 --- a/hledger/doc/other/hledger_timeclock.5.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timeclock.5.info \ No newline at end of file diff --git a/hledger/doc/other/hledger_timeclock.5.txt b/hledger/doc/other/hledger_timeclock.5.txt deleted file mode 120000 index 170d95262..000000000 --- a/hledger/doc/other/hledger_timeclock.5.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timeclock.5.txt \ No newline at end of file diff --git a/hledger/doc/other/hledger_timedot.5 b/hledger/doc/other/hledger_timedot.5 deleted file mode 120000 index dc19d7f1e..000000000 --- a/hledger/doc/other/hledger_timedot.5 +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timedot.5 \ No newline at end of file diff --git a/hledger/doc/other/hledger_timedot.5.info b/hledger/doc/other/hledger_timedot.5.info deleted file mode 120000 index f7f6bf725..000000000 --- a/hledger/doc/other/hledger_timedot.5.info +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timedot.5.info \ No newline at end of file diff --git a/hledger/doc/other/hledger_timedot.5.txt b/hledger/doc/other/hledger_timedot.5.txt deleted file mode 120000 index fc23e8078..000000000 --- a/hledger/doc/other/hledger_timedot.5.txt +++ /dev/null @@ -1 +0,0 @@ -../../../hledger-lib/doc/hledger_timedot.5.txt \ No newline at end of file diff --git a/hledger/doc/hledger.1 b/hledger/hledger.1 similarity index 100% rename from hledger/doc/hledger.1 rename to hledger/hledger.1 diff --git a/hledger/hledger.cabal b/hledger/hledger.cabal index eadc13ec6..06308a10d 100644 --- a/hledger/hledger.cabal +++ b/hledger/hledger.cabal @@ -34,30 +34,30 @@ extra-source-files: test/test.hs data-files: - doc/hledger.1 - doc/hledger.1.info - doc/hledger.1.txt - doc/other/hledger-api.1 - doc/other/hledger-api.1.info - doc/other/hledger-api.1.txt - doc/other/hledger-ui.1 - doc/other/hledger-ui.1.info - doc/other/hledger-ui.1.txt - doc/other/hledger-web.1 - doc/other/hledger-web.1.info - doc/other/hledger-web.1.txt - doc/other/hledger_csv.5 - doc/other/hledger_csv.5.info - doc/other/hledger_csv.5.txt - doc/other/hledger_journal.5 - doc/other/hledger_journal.5.info - doc/other/hledger_journal.5.txt - doc/other/hledger_timeclock.5 - doc/other/hledger_timeclock.5.info - doc/other/hledger_timeclock.5.txt - doc/other/hledger_timedot.5 - doc/other/hledger_timedot.5.info - doc/other/hledger_timedot.5.txt + .otherdocs/hledger-api.1 + .otherdocs/hledger-api.info + .otherdocs/hledger-api.txt + .otherdocs/hledger-ui.1 + .otherdocs/hledger-ui.info + .otherdocs/hledger-ui.txt + .otherdocs/hledger-web.1 + .otherdocs/hledger-web.info + .otherdocs/hledger-web.txt + .otherdocs/hledger_csv.5 + .otherdocs/hledger_csv.info + .otherdocs/hledger_csv.txt + .otherdocs/hledger_journal.5 + .otherdocs/hledger_journal.info + .otherdocs/hledger_journal.txt + .otherdocs/hledger_timeclock.5 + .otherdocs/hledger_timeclock.info + .otherdocs/hledger_timeclock.txt + .otherdocs/hledger_timedot.5 + .otherdocs/hledger_timedot.info + .otherdocs/hledger_timedot.txt + hledger.1 + hledger.info + hledger.txt source-repository head type: git diff --git a/hledger/doc/hledger.1.info b/hledger/hledger.info similarity index 100% rename from hledger/doc/hledger.1.info rename to hledger/hledger.info diff --git a/hledger/doc/hledger.1.m4.md b/hledger/hledger.m4.md similarity index 87% rename from hledger/doc/hledger.1.m4.md rename to hledger/hledger.m4.md index 2902401da..6904f5481 100644 --- a/hledger/doc/hledger.1.m4.md +++ b/hledger/hledger.m4.md @@ -5,13 +5,13 @@ m4_dnl This man page is composed from multiple files as follows: m4_dnl m4_dnl hledger.1.m4.md -m4_dnl examples.m4.md -m4_dnl options.m4.md -m4_dnl queries.m4.md -m4_dnl commands.m4.md -m4_dnl balance.m4.md -m4_dnl addons.m4.md -m4_dnl troubleshooting.m4.md +m4_dnl hledger_examples.m4.md +m4_dnl hledger_options.m4.md +m4_dnl hledger_queries.m4.md +m4_dnl hledger_commands.m4.md +m4_dnl hledger_balance.m4.md +m4_dnl hledger_addons.m4.md +m4_dnl hledger_troubleshooting.m4.md _web_({{ _docversionlinks_({{hledger}}) @@ -71,10 +71,10 @@ To get started, you can either save some entries like the above in try some commands like `hledger print` or `hledger balance`. Run `hledger` with no arguments for a list of commands. -_include_(examples.m4.md) -_include_(options.m4.md) -_include_(queries.m4.md) -_include_(commands.m4.md) +_include_(hledger_examples.m4.md) +_include_(hledger_options.m4.md) +_include_(hledger_queries.m4.md) +_include_(hledger_commands.m4.md) _man_({{ # ENVIRONMENT @@ -104,6 +104,6 @@ Not all of Ledger's journal file syntax is supported. See [file format differenc On large data files, hledger is slower and uses more memory than Ledger. -_include_(troubleshooting.m4.md) +_include_(hledger_troubleshooting.m4.md) }}) diff --git a/hledger/doc/hledger.1.txt b/hledger/hledger.txt similarity index 100% rename from hledger/doc/hledger.1.txt rename to hledger/hledger.txt diff --git a/hledger/doc/addons.m4.md b/hledger/hledger_addons.m4.md similarity index 100% rename from hledger/doc/addons.m4.md rename to hledger/hledger_addons.m4.md diff --git a/hledger/doc/balance.m4.md b/hledger/hledger_balance.m4.md similarity index 100% rename from hledger/doc/balance.m4.md rename to hledger/hledger_balance.m4.md diff --git a/hledger/doc/commands.m4.md b/hledger/hledger_commands.m4.md similarity index 99% rename from hledger/doc/commands.m4.md rename to hledger/hledger_commands.m4.md index b898c33e7..2395bd109 100644 --- a/hledger/doc/commands.m4.md +++ b/hledger/hledger_commands.m4.md @@ -168,7 +168,7 @@ Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ }}) -_include_({{balance.m4.md}}) +_include_({{hledger_balance.m4.md}}) ## balancesheet Show a balance sheet. Alias: bs. @@ -783,4 +783,4 @@ With a regular expression argument, it selects only tests with matching names. It's mainly used in development, but it's also nice to be able to check your hledger executable for smoke at any time. -_include_(addons.m4.md) +_include_(hledger_addons.m4.md) diff --git a/hledger/doc/examples.m4.md b/hledger/hledger_examples.m4.md similarity index 100% rename from hledger/doc/examples.m4.md rename to hledger/hledger_examples.m4.md diff --git a/hledger/doc/options.m4.md b/hledger/hledger_options.m4.md similarity index 100% rename from hledger/doc/options.m4.md rename to hledger/hledger_options.m4.md diff --git a/hledger/doc/queries.m4.md b/hledger/hledger_queries.m4.md similarity index 100% rename from hledger/doc/queries.m4.md rename to hledger/hledger_queries.m4.md diff --git a/hledger/doc/troubleshooting.m4.md b/hledger/hledger_troubleshooting.m4.md similarity index 100% rename from hledger/doc/troubleshooting.m4.md rename to hledger/hledger_troubleshooting.m4.md diff --git a/hledger/package.yaml b/hledger/package.yaml index 9560ab69e..864c9df93 100644 --- a/hledger/package.yaml +++ b/hledger/package.yaml @@ -29,30 +29,30 @@ extra-source-files: - bench/10000x1000x10.journal data-files: -- doc/hledger.1 -- doc/hledger.1.txt -- doc/hledger.1.info -- doc/other/hledger-api.1 -- doc/other/hledger-api.1.txt -- doc/other/hledger-api.1.info -- doc/other/hledger-ui.1 -- doc/other/hledger-ui.1.txt -- doc/other/hledger-ui.1.info -- doc/other/hledger-web.1 -- doc/other/hledger-web.1.txt -- doc/other/hledger-web.1.info -- doc/other/hledger_journal.5 -- doc/other/hledger_journal.5.txt -- doc/other/hledger_journal.5.info -- doc/other/hledger_csv.5 -- doc/other/hledger_csv.5.txt -- doc/other/hledger_csv.5.info -- doc/other/hledger_timeclock.5 -- doc/other/hledger_timeclock.5.txt -- doc/other/hledger_timeclock.5.info -- doc/other/hledger_timedot.5 -- doc/other/hledger_timedot.5.txt -- doc/other/hledger_timedot.5.info +- hledger.1 +- hledger.txt +- hledger.info +- .otherdocs/hledger-api.1 +- .otherdocs/hledger-api.txt +- .otherdocs/hledger-api.info +- .otherdocs/hledger-ui.1 +- .otherdocs/hledger-ui.txt +- .otherdocs/hledger-ui.info +- .otherdocs/hledger-web.1 +- .otherdocs/hledger-web.txt +- .otherdocs/hledger-web.info +- .otherdocs/hledger_journal.5 +- .otherdocs/hledger_journal.txt +- .otherdocs/hledger_journal.info +- .otherdocs/hledger_csv.5 +- .otherdocs/hledger_csv.txt +- .otherdocs/hledger_csv.info +- .otherdocs/hledger_timeclock.5 +- .otherdocs/hledger_timeclock.txt +- .otherdocs/hledger_timeclock.info +- .otherdocs/hledger_timedot.5 +- .otherdocs/hledger_timedot.txt +- .otherdocs/hledger_timedot.info flags: terminfo: