Skip to content

Commit c637749

Browse files
tomsmedingMikolaj
authored andcommitted
Use clearer notation for single and double quotes in docs
This handles geekosaur's review.
1 parent 18205dc commit c637749

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

Cabal/src/Distribution/Simple/Setup/Benchmark.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ benchmarkOptions' showOrParseArgs =
118118
[]
119119
["benchmark-options"]
120120
( "give extra options to benchmark executables "
121-
++ "(split on spaces, \"quotes\" prevent splitting; "
121+
++ "(split on spaces, use \"\" to prevent splitting; "
122122
++ "name templates can use $pkgid, $compiler, "
123123
++ "$os, $arch, $benchmark)"
124124
)

Cabal/src/Distribution/Simple/Setup/Common.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ programDbOptions progDb showOrParseArgs get set =
316316
[prog ++ "-options"]
317317
( "give extra options to "
318318
++ prog
319-
++ " (split on spaces, \"quotes\" prevent splitting)"
319+
++ " (split on spaces, use \"\" to prevent splitting)"
320320
)
321321
get
322322
set

Cabal/src/Distribution/Simple/Setup/Test.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ testOptions' showOrParseArgs =
245245
[]
246246
["test-options"]
247247
( "give extra options to test executables "
248-
++ "(split on spaces, \"quotes\" prevent splitting; "
248+
++ "(split on spaces, use \"\" to prevent splitting; "
249249
++ "name templates can use $pkgid, $compiler, "
250250
++ "$os, $arch, $test-suite)"
251251
)

doc/cabal-commands.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1069,7 +1069,7 @@ configuration from the 'cabal.project', 'cabal.project.local' and other files.
10691069
``--repl-options`` bypasses this and allows you to specify options to the
10701070
invoked REPL without influencing the build configuration for other packages.
10711071

1072-
Note: ``--repl-options`` does not accept ``"quotes"`` to pass options
1072+
Note: ``--repl-options`` does not accept double quotes (``""``) to pass options
10731073
containing spaces to the REPL.
10741074

10751075
.. option:: --repl-no-load

doc/setup-commands.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -210,11 +210,11 @@ files of a package:
210210
to Cabal can be used in place of *prog*. For example:
211211
``--alex-options="--template=mytemplatedir/"``. The *options* is
212212
split into program options based on spaces. Any options containing
213-
embedded spaces need to be quoted with "double quotes", for example
214-
``--foo-options='--bar="C:\Program Files\Bar"'``. (The ``'single'`` quotes
215-
are for your shell, the ``"double"`` quotes are passed to Cabal.) As an
216-
alternative that takes only one option at a time but avoids the need to
217-
quote, use :option:`--PROG-option` instead.
213+
embedded spaces need to be quoted with double quotes (``""``), for example
214+
``--foo-options='--bar="C:\Program Files\Bar"'``. (The single quotes
215+
(``''``) are for your shell, the ``"double"`` quotes are passed to Cabal.)
216+
As an alternative that takes only one option at a time but avoids the need
217+
to quote, use :option:`--PROG-option` instead.
218218

219219
Note: if *prog* is ``ghc``, then options that do not affect build
220220
artifacts, such as warning flags, are dropped. This is because
@@ -1459,7 +1459,7 @@ Flags for repl:
14591459

14601460
.. option:: --PROG-options=OPTS
14611461

1462-
Give extra options to PROG (split on spaces, "quotes" prevent splitting).
1462+
Give extra options to PROG (split on spaces, use "" to prevent splitting).
14631463

14641464
.. option:: --repl-no-load
14651465

0 commit comments

Comments
 (0)