1
1
mirror of https://github.com/sol/hpack.git synced 2024-10-04 11:47:15 +03:00

Add disclaimer for verbatim to README

This commit is contained in:
Simon Hengel 2018-08-19 14:23:10 +08:00
parent 0760adc389
commit 2b98e17632

View File

@ -304,6 +304,14 @@ It is recognized top-level, in sections, and in conditionals.
`verbatim` accepts an object or a string (or a list of objects and strings).
***Disclaimer:*** The content of `verbatim` fields are merged into the
generated `.cabal` file as a final step, after Hpack is done with most of its
work. Before that final step Hpack does not look at any `verbatim` fields.
Consequently, the content of a `verbatim` field does not affect any other
fields that are populated by Hpack. As an example, if you use `verbatim` to
override `hs-source-dirs`, the overridden information will not be used when
Hpack infers `exposed-modules` or `other-modules`.
#### Objects
When an object is used: