From 5cea120ab7981acc8319603318318f1bcdc47c85 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 26 Jan 2018 11:12:08 -0800 Subject: [PATCH] cli: rename embedded files dir, make them extra-source-files Per feedback from peti. These files will no longer be installed to cabal's data directory, where it might seem as if they are required at runtime, which they are not. Packagers will still find them in the tarball and can put them in the proper place. --- hledger/.otherdocs/README | 4 -- hledger/Hledger/Cli/DocFiles.hs | 48 ++++++++--------- hledger/embeddedfiles/README | 4 ++ .../hledger-api.1 | 0 .../hledger-api.info | 0 .../hledger-api.txt | 0 .../hledger-ui.1 | 0 .../hledger-ui.info | 0 .../hledger-ui.txt | 0 .../hledger-web.1 | 0 .../hledger-web.info | 0 .../hledger-web.txt | 0 hledger/embeddedfiles/hledger.1 | 1 + hledger/embeddedfiles/hledger.info | 1 + hledger/embeddedfiles/hledger.txt | 1 + .../hledger_csv.5 | 0 .../hledger_csv.info | 0 .../hledger_csv.txt | 0 .../hledger_journal.5 | 0 .../hledger_journal.info | 0 .../hledger_journal.txt | 0 .../hledger_timeclock.5 | 0 .../hledger_timeclock.info | 0 .../hledger_timeclock.txt | 0 .../hledger_timedot.5 | 0 .../hledger_timedot.info | 0 .../hledger_timedot.txt | 0 hledger/hledger.cabal | 52 +++++++++---------- hledger/package.yaml | 50 +++++++++--------- 29 files changed, 81 insertions(+), 80 deletions(-) delete mode 100644 hledger/.otherdocs/README create mode 100644 hledger/embeddedfiles/README rename hledger/{.otherdocs => embeddedfiles}/hledger-api.1 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-api.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-api.txt (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-ui.1 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-ui.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-ui.txt (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-web.1 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-web.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger-web.txt (100%) create mode 120000 hledger/embeddedfiles/hledger.1 create mode 120000 hledger/embeddedfiles/hledger.info create mode 120000 hledger/embeddedfiles/hledger.txt rename hledger/{.otherdocs => embeddedfiles}/hledger_csv.5 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_csv.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_csv.txt (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_journal.5 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_journal.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_journal.txt (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timeclock.5 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timeclock.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timeclock.txt (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timedot.5 (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timedot.info (100%) rename hledger/{.otherdocs => embeddedfiles}/hledger_timedot.txt (100%) diff --git a/hledger/.otherdocs/README b/hledger/.otherdocs/README deleted file mode 100644 index f6d5956cf..000000000 --- a/hledger/.otherdocs/README +++ /dev/null @@ -1,4 +0,0 @@ -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/Hledger/Cli/DocFiles.hs b/hledger/Hledger/Cli/DocFiles.hs index 05c289a0b..1b60e481f 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 "hledger.1" >>= embedStringFile) - ,$(makeRelativeToProject "hledger.txt" >>= embedStringFile) - ,$(makeRelativeToProject "hledger.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger.1" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger.info" >>= embedStringFile) )) ,("hledger-ui", - ($(makeRelativeToProject ".otherdocs/hledger-ui.1" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-ui.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-ui.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger-ui.1" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-ui.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-ui.info" >>= embedStringFile) )) ,("hledger-web", - ($(makeRelativeToProject ".otherdocs/hledger-web.1" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-web.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-web.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger-web.1" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-web.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-web.info" >>= embedStringFile) )) ,("hledger-api", - ($(makeRelativeToProject ".otherdocs/hledger-api.1" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-api.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger-api.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger-api.1" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-api.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger-api.info" >>= embedStringFile) )) ,("journal", - ($(makeRelativeToProject ".otherdocs/hledger_journal.5" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_journal.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_journal.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger_journal.5" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_journal.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_journal.info" >>= embedStringFile) )) ,("csv", - ($(makeRelativeToProject ".otherdocs/hledger_csv.5" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_csv.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_csv.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger_csv.5" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_csv.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_csv.info" >>= embedStringFile) )) ,("timeclock", - ($(makeRelativeToProject ".otherdocs/hledger_timeclock.5" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_timeclock.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_timeclock.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger_timeclock.5" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_timeclock.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_timeclock.info" >>= embedStringFile) )) ,("timedot", - ($(makeRelativeToProject ".otherdocs/hledger_timedot.5" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_timedot.txt" >>= embedStringFile) - ,$(makeRelativeToProject ".otherdocs/hledger_timedot.info" >>= embedStringFile) + ($(makeRelativeToProject "embeddedfiles/hledger_timedot.5" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_timedot.txt" >>= embedStringFile) + ,$(makeRelativeToProject "embeddedfiles/hledger_timedot.info" >>= embedStringFile) )) ] diff --git a/hledger/embeddedfiles/README b/hledger/embeddedfiles/README new file mode 100644 index 000000000..4ab2ddc69 --- /dev/null +++ b/hledger/embeddedfiles/README @@ -0,0 +1,4 @@ +Symbolic links to all the main hledger manuals in several formats. +These files are embedded into the hledger executable at compile time, in Hledger/Cli/DocFiles.hs. +Having them symlinked here allows embedding them without using absolute paths, +which is allowed only within the current package directory. diff --git a/hledger/.otherdocs/hledger-api.1 b/hledger/embeddedfiles/hledger-api.1 similarity index 100% rename from hledger/.otherdocs/hledger-api.1 rename to hledger/embeddedfiles/hledger-api.1 diff --git a/hledger/.otherdocs/hledger-api.info b/hledger/embeddedfiles/hledger-api.info similarity index 100% rename from hledger/.otherdocs/hledger-api.info rename to hledger/embeddedfiles/hledger-api.info diff --git a/hledger/.otherdocs/hledger-api.txt b/hledger/embeddedfiles/hledger-api.txt similarity index 100% rename from hledger/.otherdocs/hledger-api.txt rename to hledger/embeddedfiles/hledger-api.txt diff --git a/hledger/.otherdocs/hledger-ui.1 b/hledger/embeddedfiles/hledger-ui.1 similarity index 100% rename from hledger/.otherdocs/hledger-ui.1 rename to hledger/embeddedfiles/hledger-ui.1 diff --git a/hledger/.otherdocs/hledger-ui.info b/hledger/embeddedfiles/hledger-ui.info similarity index 100% rename from hledger/.otherdocs/hledger-ui.info rename to hledger/embeddedfiles/hledger-ui.info diff --git a/hledger/.otherdocs/hledger-ui.txt b/hledger/embeddedfiles/hledger-ui.txt similarity index 100% rename from hledger/.otherdocs/hledger-ui.txt rename to hledger/embeddedfiles/hledger-ui.txt diff --git a/hledger/.otherdocs/hledger-web.1 b/hledger/embeddedfiles/hledger-web.1 similarity index 100% rename from hledger/.otherdocs/hledger-web.1 rename to hledger/embeddedfiles/hledger-web.1 diff --git a/hledger/.otherdocs/hledger-web.info b/hledger/embeddedfiles/hledger-web.info similarity index 100% rename from hledger/.otherdocs/hledger-web.info rename to hledger/embeddedfiles/hledger-web.info diff --git a/hledger/.otherdocs/hledger-web.txt b/hledger/embeddedfiles/hledger-web.txt similarity index 100% rename from hledger/.otherdocs/hledger-web.txt rename to hledger/embeddedfiles/hledger-web.txt diff --git a/hledger/embeddedfiles/hledger.1 b/hledger/embeddedfiles/hledger.1 new file mode 120000 index 000000000..c2cccd0bd --- /dev/null +++ b/hledger/embeddedfiles/hledger.1 @@ -0,0 +1 @@ +../hledger.1 \ No newline at end of file diff --git a/hledger/embeddedfiles/hledger.info b/hledger/embeddedfiles/hledger.info new file mode 120000 index 000000000..efd2e03c4 --- /dev/null +++ b/hledger/embeddedfiles/hledger.info @@ -0,0 +1 @@ +../hledger.info \ No newline at end of file diff --git a/hledger/embeddedfiles/hledger.txt b/hledger/embeddedfiles/hledger.txt new file mode 120000 index 000000000..a54a67123 --- /dev/null +++ b/hledger/embeddedfiles/hledger.txt @@ -0,0 +1 @@ +../hledger.txt \ No newline at end of file diff --git a/hledger/.otherdocs/hledger_csv.5 b/hledger/embeddedfiles/hledger_csv.5 similarity index 100% rename from hledger/.otherdocs/hledger_csv.5 rename to hledger/embeddedfiles/hledger_csv.5 diff --git a/hledger/.otherdocs/hledger_csv.info b/hledger/embeddedfiles/hledger_csv.info similarity index 100% rename from hledger/.otherdocs/hledger_csv.info rename to hledger/embeddedfiles/hledger_csv.info diff --git a/hledger/.otherdocs/hledger_csv.txt b/hledger/embeddedfiles/hledger_csv.txt similarity index 100% rename from hledger/.otherdocs/hledger_csv.txt rename to hledger/embeddedfiles/hledger_csv.txt diff --git a/hledger/.otherdocs/hledger_journal.5 b/hledger/embeddedfiles/hledger_journal.5 similarity index 100% rename from hledger/.otherdocs/hledger_journal.5 rename to hledger/embeddedfiles/hledger_journal.5 diff --git a/hledger/.otherdocs/hledger_journal.info b/hledger/embeddedfiles/hledger_journal.info similarity index 100% rename from hledger/.otherdocs/hledger_journal.info rename to hledger/embeddedfiles/hledger_journal.info diff --git a/hledger/.otherdocs/hledger_journal.txt b/hledger/embeddedfiles/hledger_journal.txt similarity index 100% rename from hledger/.otherdocs/hledger_journal.txt rename to hledger/embeddedfiles/hledger_journal.txt diff --git a/hledger/.otherdocs/hledger_timeclock.5 b/hledger/embeddedfiles/hledger_timeclock.5 similarity index 100% rename from hledger/.otherdocs/hledger_timeclock.5 rename to hledger/embeddedfiles/hledger_timeclock.5 diff --git a/hledger/.otherdocs/hledger_timeclock.info b/hledger/embeddedfiles/hledger_timeclock.info similarity index 100% rename from hledger/.otherdocs/hledger_timeclock.info rename to hledger/embeddedfiles/hledger_timeclock.info diff --git a/hledger/.otherdocs/hledger_timeclock.txt b/hledger/embeddedfiles/hledger_timeclock.txt similarity index 100% rename from hledger/.otherdocs/hledger_timeclock.txt rename to hledger/embeddedfiles/hledger_timeclock.txt diff --git a/hledger/.otherdocs/hledger_timedot.5 b/hledger/embeddedfiles/hledger_timedot.5 similarity index 100% rename from hledger/.otherdocs/hledger_timedot.5 rename to hledger/embeddedfiles/hledger_timedot.5 diff --git a/hledger/.otherdocs/hledger_timedot.info b/hledger/embeddedfiles/hledger_timedot.info similarity index 100% rename from hledger/.otherdocs/hledger_timedot.info rename to hledger/embeddedfiles/hledger_timedot.info diff --git a/hledger/.otherdocs/hledger_timedot.txt b/hledger/embeddedfiles/hledger_timedot.txt similarity index 100% rename from hledger/.otherdocs/hledger_timedot.txt rename to hledger/embeddedfiles/hledger_timedot.txt diff --git a/hledger/hledger.cabal b/hledger/hledger.cabal index 45869d253..e8b44566e 100644 --- a/hledger/hledger.cabal +++ b/hledger/hledger.cabal @@ -2,7 +2,7 @@ -- -- see: https://github.com/sol/hpack -- --- hash: cb1407ac28a973e8fc74c9e78c06c2c29715873a64eb4586417cf02d12bfa60f +-- hash: dd03cb6cac12f8e524583863aef51ed01ef1c5fb45efb109ad478be0d14aa5d1 name: hledger version: 1.5.99 @@ -32,35 +32,33 @@ cabal-version: >= 1.10 extra-source-files: bench/10000x1000x10.journal CHANGES + embeddedfiles/hledger-api.1 + embeddedfiles/hledger-api.info + embeddedfiles/hledger-api.txt + embeddedfiles/hledger-ui.1 + embeddedfiles/hledger-ui.info + embeddedfiles/hledger-ui.txt + embeddedfiles/hledger-web.1 + embeddedfiles/hledger-web.info + embeddedfiles/hledger-web.txt + embeddedfiles/hledger.1 + embeddedfiles/hledger.info + embeddedfiles/hledger.txt + embeddedfiles/hledger_csv.5 + embeddedfiles/hledger_csv.info + embeddedfiles/hledger_csv.txt + embeddedfiles/hledger_journal.5 + embeddedfiles/hledger_journal.info + embeddedfiles/hledger_journal.txt + embeddedfiles/hledger_timeclock.5 + embeddedfiles/hledger_timeclock.info + embeddedfiles/hledger_timeclock.txt + embeddedfiles/hledger_timedot.5 + embeddedfiles/hledger_timedot.info + embeddedfiles/hledger_timedot.txt README.md test/test.hs -data-files: - .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 location: https://github.com/simonmichael/hledger diff --git a/hledger/package.yaml b/hledger/package.yaml index 6b5883160..c4aa96c53 100644 --- a/hledger/package.yaml +++ b/hledger/package.yaml @@ -27,32 +27,32 @@ extra-source-files: - README.md - test/test.hs - bench/10000x1000x10.journal +- embeddedfiles/hledger.1 +- embeddedfiles/hledger.txt +- embeddedfiles/hledger.info +- embeddedfiles/hledger-api.1 +- embeddedfiles/hledger-api.txt +- embeddedfiles/hledger-api.info +- embeddedfiles/hledger-ui.1 +- embeddedfiles/hledger-ui.txt +- embeddedfiles/hledger-ui.info +- embeddedfiles/hledger-web.1 +- embeddedfiles/hledger-web.txt +- embeddedfiles/hledger-web.info +- embeddedfiles/hledger_journal.5 +- embeddedfiles/hledger_journal.txt +- embeddedfiles/hledger_journal.info +- embeddedfiles/hledger_csv.5 +- embeddedfiles/hledger_csv.txt +- embeddedfiles/hledger_csv.info +- embeddedfiles/hledger_timeclock.5 +- embeddedfiles/hledger_timeclock.txt +- embeddedfiles/hledger_timeclock.info +- embeddedfiles/hledger_timedot.5 +- embeddedfiles/hledger_timedot.txt +- embeddedfiles/hledger_timedot.info -data-files: -- 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 +#data-files: flags: terminfo: