[doc] Remove references to "Nix" in "How to build locally..." #11008
Conversation
| @@ -23,14 +23,14 @@ To run an executable defined in this package, use this command: | |||
|
|
|||
| :: | |||
|
|
|||
| $ cabal run <executable name> [executable args] | |||
| $ cabal run <executable name> -- [executable args] | |||
There was a problem hiding this comment.
Nice! I think people quite often forget and then run into issues
There was a problem hiding this comment.
This actually can work without --. Maybe this is a misfeature but it works...
In particular, cabal run has a special argument parser that takes into account a curious fact: cabal run can only take one target (unlike many other subcommand like build or test), so, everything after it can be treated as arguments for the executable. Unless... well, the manual says it all:
Except in the case of the empty target, the strings after it will be passed to the executable as arguments.
If one of the arguments starts with - it will be interpreted as a cabal flag, so if you need to pass flags to the executable you have to separate them with --.
https://cabal.readthedocs.io/en/3.14/cabal-commands.html#cabal-run
Now, what to do about it: I'm ambivalent. If people think that this is confusing, I'm fine with --.
|
@simonmar: thank you for the PR. Please feel free to set the merge_me label to start the ~2 days merging process. |
There was a problem hiding this comment.
Should we rename both files so that the URL doesn't mention Nix as well?
| commands. For example, flags passed to ``cabal build`` are only | ||
| applied to *local* packages, so that adding a flag to | ||
| ``cabal build`` doesn't necessitate a rebuild of *every* transitive | ||
| dependency in the global package store. | ||
|
|
||
| In cabal-install 2.0 and above, Nix-style local builds also take advantage of a | ||
| new Cabal library feature, `per-component | ||
| builds <https://github.com/ezyang/ghc-proposals/blob/master/proposals/0000-componentized-cabal.rst>`__, |
There was a problem hiding this comment.
So, we lose this link in this patch... It may be good to think about preserving it in some form. I don't think there's a comparable explanation in the manual itself currently.
See #6105
Please read Github PR Conventions and then fill in one of these two templates.