Skip to content
Snippets Groups Projects
Commit 3d3986fa authored by Victor Nawothnig's avatar Victor Nawothnig Committed by mergify-bot
Browse files

Adjust documentation for run command

parent d1b0391a
No related branches found
No related tags found
No related merge requests found
......@@ -121,8 +121,9 @@ runCommand = CommandUI
++ "Any executable-like component in any package in the project can be "
++ "specified. A package can be specified if contains just one "
++ "executable-like. The default is to use the package in the current "
++ "directory if it contains just one executable-like.\n\n"
++ "executable-like, preferring a single executable. The default is to "
++ "use the package in the current directory if it contains just one "
++ "executable-like.\n\n"
++ "Extra arguments can be passed to the program, but use '--' to "
++ "separate arguments for the program from arguments for " ++ pname
......
......@@ -194,6 +194,19 @@ Tests and benchmarks are also treated as executables.
See `the v2-build section <#cabal-v2-build>`__ for the target syntax.
When ``TARGET`` is one of the following:
- A component target: execute the specified executable, benchmark or test suite
- A package target:
1. If the package has exactly one executable component, it will be selected.
2. If the package has multiple executable components, an error is raised.
3. If the package has exactly one test or benchmark component, it will be selected.
4. Otherwise an issue is raised
- Empty target: Same as package target, implicitly using the package from the current
working directory.
Except in the case of the empty target, the strings after it will be
passed to the executable as arguments.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment