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.
This commit is contained in:
Simon Michael 2018-01-26 11:12:08 -08:00
parent 9ab8c5c4da
commit 5cea120ab7
29 changed files with 81 additions and 80 deletions

View File

@ -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).

View File

@ -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)
))
]

View File

@ -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.

View File

@ -0,0 +1 @@
../hledger.1

View File

@ -0,0 +1 @@
../hledger.info

View File

@ -0,0 +1 @@
../hledger.txt

View File

@ -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

View File

@ -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: