Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Give an example for --enable-nix flag #8333

Merged
merged 3 commits into from
Aug 3, 2022
Merged

Give an example for --enable-nix flag #8333

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06db28d
Give an example for `--enable-nix` flag
blackheaven Jul 30, 2022
5663e82
fixup! Give an example for `--enable-nix` flag
blackheaven Jul 30, 2022
115888d
fixup! Give an example for `--enable-nix` flag
blackheaven Jul 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions doc/nix-integration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,8 @@ Nix Integration
Enabling Nix Integration
------------------------

To enable Nix integration, simply pass the ``--enable-nix`` global
option when you call ``cabal``. To use this option everywhere, edit
your :ref:`global configuration file<config-file-discovery>`
(default: ``$HOME/.cabal/config``) to include:
To enable Nix integration, simply pass the ``--enable-nix`` global option when you call ``cabal`` (eg. ``cabal --enable-nix build``).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm afraid this won't work with new enough cabals, because now build is an alias for v2-build. You probably want to say v1-build. Actually, if the flag does nothing with v2- commands, it would be great to also change all the examples below by prepending command names with v1-? Otherwise, we are just adding content to misleading documentation.

To use this option everywhere, edit your :ref:`global configuration file<config-file-discovery>` (default: ``$HOME/.cabal/config``) to include:

.. code-block:: cabal

Expand Down