diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2016-01-21 11:36:00 +0100 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2016-01-21 14:59:06 +0100 |
| commit | f23b578f792a357fa754604188eea46ca46cf613 (patch) | |
| tree | 776b74eaad38b9e76e21df7eac19141267ff62cb | |
| parent | ede055eb230ac33da276f1416678f99e32e83da2 (diff) | |
| download | haskell-f23b578f792a357fa754604188eea46ca46cf613.tar.gz | |
user-guide:: Improve -D description
| -rw-r--r-- | docs/users_guide/phases.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/users_guide/phases.rst b/docs/users_guide/phases.rst index 0428956276..bc4e90f3a9 100644 --- a/docs/users_guide/phases.rst +++ b/docs/users_guide/phases.rst @@ -161,11 +161,14 @@ Options affecting the C pre-processor large system with significant doses of conditional compilation, you really shouldn't need it. -.. ghc-flag:: -D ⟨symbol⟩[=⟨value⟩] +.. ghc-flag:: -D <symbol>[=<value>] Define macro ⟨symbol⟩ in the usual way. NB: does *not* affect ``-D`` - macros passed to the C compiler when compiling via C! For those, use - the ``-optc-Dfoo`` hack… (see :ref:`forcing-options-through`). + macros passed to the C compiler when compiling with :ghc-flag:`-fvia-C`! For + those, use the ``-optc-Dfoo`` hack… (see :ref:`forcing-options-through`). + + When no value is given, the value is taken to be ``1``. For instance, + ``-DUSE_MYLIB`` is equivalent to ``-DUSE_MYLIB=1``. .. ghc-flag:: -U ⟨symbol⟩ |