Skip to content

Commit 4328ce2

Browse files
committed
Fix #4894: document alternatives to write a tested-with list
A grab-bag of alternatives as discussed at #4894.
1 parent 17e5a84 commit 4328ce2

File tree

1 file changed

+64
-5
lines changed

1 file changed

+64
-5
lines changed

doc/cabal-package.rst

+64-5
Original file line numberDiff line numberDiff line change
@@ -629,19 +629,78 @@ describe the package as a whole:
629629
and is rather intended as extra metadata for use by third party
630630
tooling, such as e.g. CI tooling.
631631

632-
Here's a typical usage example
632+
Here's a typical usage example:
633633

634634
::
635635

636-
tested-with: GHC == 8.6.3, GHC == 8.4.4, GHC == 8.2.2, GHC == 8.0.2,
636+
tested-with: GHC == 9.0.1, GHC == 8.10.4, GHC == 8.8.4,
637+
GHC == 8.6.5, GHC == 8.4.4, GHC == 8.2.2, GHC == 8.0.2,
637638
GHC == 7.10.3, GHC == 7.8.4, GHC == 7.6.3, GHC == 7.4.2
638639

639-
which can (starting with Cabal 3.0) also be written using the more
640-
concise set notation syntax
640+
The same can be spread over several lines, for instance:
641641

642642
::
643643

644-
tested-with: GHC == { 8.6.3, 8.4.4, 8.2.2, 8.0.2, 7.10.3, 7.8.4, 7.6.3, 7.4.2 }
644+
tested-with: GHC == 9.0.1
645+
, GHC == 8.10.4
646+
, GHC == 8.8.4
647+
, GHC == 8.6.5
648+
, GHC == 8.4.4
649+
, GHC == 8.2.2
650+
, GHC == 8.0.2
651+
, GHC == 7.10.3
652+
, GHC == 7.8.4
653+
, GHC == 7.6.3
654+
, GHC == 7.4.2
655+
656+
The separating comma can also be dropped altogether:
657+
658+
::
659+
660+
tested-with:
661+
GHC == 9.0.1
662+
GHC == 8.10.4
663+
GHC == 8.8.4
664+
GHC == 8.6.5
665+
GHC == 8.4.4
666+
GHC == 8.2.2
667+
GHC == 8.0.2
668+
GHC == 7.10.3
669+
GHC == 7.8.4
670+
GHC == 7.6.3
671+
GHC == 7.4.2
672+
673+
However, this alternative might
674+
`disappear <https://github.com/haskell/cabal/issues/4894#issuecomment-909008657>`__
675+
in the future.
676+
677+
678+
Starting with :pkg-field:`cabal-version` 3.0,
679+
there are further conveniences.
680+
First, a preceding ``,`` is allowed, so a bullet-list style
681+
is possible (recommended):
682+
683+
::
684+
685+
tested-with:
686+
, GHC == 9.0.1
687+
, GHC == 8.10.4
688+
, GHC == 8.8.4
689+
, GHC == 8.6.5
690+
, GHC == 8.4.4
691+
, GHC == 8.2.2
692+
, GHC == 8.0.2
693+
, GHC == 7.10.3
694+
, GHC == 7.8.4
695+
, GHC == 7.6.3
696+
, GHC == 7.4.2
697+
698+
699+
Second, a concise set notation syntax is available:
700+
701+
::
702+
703+
tested-with: GHC == { 9.0.1, 8.10.4, 8.8.4, 8.6.5, 8.4.4, 8.2.2, 8.0.2, 7.10.3, 7.8.4, 7.6.3, 7.4.2 }
645704

646705
.. pkg-field:: data-files: filename list
647706

0 commit comments

Comments
 (0)