cabal icon indicating copy to clipboard operation
cabal copied to clipboard

differentiate metavariables and literals in target syntax

Open dmwit opened this issue 6 years ago • 3 comments

In the description of target syntax for cabal v2-build, it's not super clear which bits of the syntax are variables that the user should replace with their own text, and which are literal strings that should be copied verbatim into a target string. I think it's this way:

  • variables: package, ctype, ctypes, component
  • literals: all, lib, libs, libraries, flib, flibs, foreign-libraries, exe, exes, executables, test, tests, bench, benches, benchmarks, :

Some text describing which is which would help a lot; but I think even better would be distinguishing them typographically, e.g. by making variables italic or similar.

dmwit avatar Oct 09 '19 21:10 dmwit

This is the section you're talking about, right?

https://github.com/haskell/cabal/blob/0ad0ac0b4c434b32794e03ac8f0e15801c59775c/Cabal/doc/nix-local-build.rst#L331-L389

DanielG avatar Oct 10 '19 07:10 DanielG

That's the one.

dmwit avatar Oct 10 '19 14:10 dmwit

-

damienlog avatar Nov 22 '19 01:11 damienlog