@@ -39,6 +39,41 @@ at the Singapore Haskell meetup: http://typeful.net/talks/hpack
3939
4040## Documentation
4141
42+ <!-- ts-->
43+ * [ hpack: A modern format for Haskell packages] ( #hpack-a-modern-format-for-haskell-packages )
44+ * [ Design principles] ( #design-principles )
45+ * [ Tool integration] ( #tool-integration )
46+ * [ There is no user guide] ( #there-is-no-user-guide )
47+ * [ Examples] ( #examples )
48+ * [ Documentation] ( #documentation )
49+ * [ Handling of Paths_ modules] ( #handling-of-paths_-modules )
50+ * [ Quick-reference] ( #quick-reference )
51+ * [ Top-level fields] ( #top-level-fields )
52+ * [ cabal-version] ( #cabal-version )
53+ * [ Defaults] ( #defaults )
54+ * [ Custom setup] ( #custom-setup )
55+ * [ Common fields] ( #common-fields )
56+ * [ Library fields] ( #library-fields )
57+ * [ Executable fields] ( #executable-fields )
58+ * [ Test fields] ( #test-fields )
59+ * [ Benchmark fields] ( #benchmark-fields )
60+ * [ Flags] ( #flags )
61+ * [ Dependencies] ( #dependencies )
62+ * [ Conditionals] ( #conditionals )
63+ * [ File globbing] ( #file-globbing )
64+ * [ Passing things to Cabal verbatim] ( #passing-things-to-cabal-verbatim )
65+ * [ Objects] ( #objects )
66+ * [ Strings] ( #strings )
67+ * [ Lists of objects and strings] ( #lists-of-objects-and-strings )
68+ * [ Not repeating yourself] ( #not-repeating-yourself )
69+ * [ Vim integration] ( #vim-integration )
70+ * [ Stack support] ( #stack-support )
71+ * [ Binaries for use on Travis CI] ( #binaries-for-use-on-travis-ci )
72+
73+ <!-- Added by: sol, at: Fri 19 Feb 2021 10:31:47 PM +07 -->
74+
75+ <!-- te-->
76+
4277### Handling of ` Paths_ ` modules
4378
4479Cabal generates a ` Paths_ ` module for every package. By default Hpack adds
@@ -110,7 +145,7 @@ verbatim:
110145 cabal-version: 2.2
111146` ` `
112147
113- # ### <a name="defaults"></a> Defaults
148+ # ### Defaults
114149
115150Hpack allows the inclusion of [common fields](#common-fields) from a file on
116151GitHub or a local file.
@@ -167,13 +202,13 @@ this reason it is recommended to only use tags as Git references.
167202 defaults file, then you can achieve this by adding that file to the cache
168203 manually.
169204
170- # ### <a name="custom-setup"></a> Custom setup
205+ # ### Custom setup
171206
172207| Hpack | Cabal | Default | Notes | Example |
173208| --- | --- | --- | --- | --- |
174209| `dependencies` | `setup-depends` | | Implies `build-type : Custom` | |
175210
176- # ### <a name="common-fields"></a> Common fields
211+ # ### Common fields
177212
178213These fields can be specified top-level or on a per section basis; top-level
179214values are merged with per section values.
@@ -249,7 +284,7 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
249284**Note:** Unlike `Cabal`, Hpack does not accept system executables as
250285`build-tools`. Use `system-build-tools` if you need this.
251286
252- #### <a name="library-fields"></a> Library fields
287+ #### Library fields
253288
254289| Hpack | Cabal | Default | Notes |
255290| --- | --- | --- | --- |
@@ -263,7 +298,7 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
263298| `signatures` | · | | |
264299| | `default-language` | `Haskell2010` | |
265300
266- #### <a name="executable-fields"></a> Executable fields
301+ #### Executable fields
267302
268303| Hpack | Cabal | Default | Notes |
269304| --- | --- | --- | --- |
@@ -272,7 +307,7 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
272307| `generated-other-modules` | | | Added to `other-modules` and `autogen-modules`. Since `0.23.0`.
273308| | `default-language` | `Haskell2010` | |
274309
275- #### <a name="test-fields"></a> Test fields
310+ #### Test fields
276311
277312| Hpack | Cabal | Default | Notes |
278313| --- | --- | --- | --- |
@@ -282,7 +317,7 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
282317| `generated-other-modules` | | | Added to `other-modules` and `autogen-modules`. Since `0.23.0`.
283318| | `default-language` | `Haskell2010` | |
284319
285- #### <a name="benchmark-fields"></a> Benchmark fields
320+ #### Benchmark fields
286321
287322| Hpack | Cabal | Default | Notes |
288323| --- | --- | --- | --- |
@@ -292,15 +327,15 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
292327| `generated-other-modules` | | | Added to `other-modules` and `autogen-modules`. Since `0.23.0`.
293328| | `default-language` | `Haskell2010` | |
294329
295- #### <a name="flags"></a> Flags
330+ #### Flags
296331
297332| Hpack | Cabal | Default | Notes |
298333| --- | --- | --- | --- |
299334| `description` | · | | Optional |
300335| `manual` | · | | Required (unlike Cabal) |
301336| `default` | · | | Required (unlike Cabal) |
302337
303- #### <a name="dependencies"></a> Dependencies
338+ #### Dependencies
304339
305340Dependencies can be specified as either a list or an object. These are
306341equivalent:
@@ -375,7 +410,7 @@ imported!
375410
376411`mixin` was added in version `0.31.0`.
377412
378- #### <a name="conditionals"></a> Conditionals
413+ #### Conditionals
379414
380415Conditionals with no else branch:
381416
@@ -419,7 +454,7 @@ becomes
419454**Note:** Conditionals with `condition: false` are omitted from the generated
420455`.cabal` file.
421456
422- ### <a name="file-globbing"></a> File globbing
457+ ### File globbing
423458
424459At place where you can specify a list of files you can also use glob patterns.
425460Glob patterns and ordinary file names can be freely mixed, e.g.:
0 commit comments