Skip to content

Commit 5421a4d

Browse files
committed
Remove v2-prefix from Quickstart guide
Closes haskell#9086
1 parent d92ed63 commit 5421a4d

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

doc/nix-local-build.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ local builds with this command (configuring is not necessary):
1111

1212
::
1313

14-
$ cabal v2-build
14+
$ cabal build
1515

1616
To open a GHCi shell with this package, use this command:
1717

1818
::
1919

20-
$ cabal v2-repl
20+
$ cabal repl
2121

2222
To run an executable defined in this package, use this command:
2323

2424
::
2525

26-
$ cabal v2-run <executable name> [executable args]
26+
$ cabal run <executable name> [executable args]
2727

2828
Developing multiple packages
2929
----------------------------
@@ -51,37 +51,37 @@ directory, run the command: (using cabal-install-2.0 or greater.)
5151

5252
::
5353

54-
$ cabal v2-build all
54+
$ cabal build all
5555

56-
To build a specific package, you can either run ``v2-build`` from the
56+
To build a specific package, you can either run ``build`` from the
5757
directory of the package in question:
5858

5959
::
6060

6161
$ cd cabal-install
62-
$ cabal v2-build
62+
$ cabal build
6363

6464
or you can pass the name of the package as an argument to
65-
``cabal v2-build`` (this works in any subdirectory of the project):
65+
``cabal build`` (this works in any subdirectory of the project):
6666

6767
::
6868

69-
$ cabal v2-build cabal-install
69+
$ cabal build cabal-install
7070

7171
You can also specify a specific component of the package to build. For
7272
example, to build a test suite named ``package-tests``, use the command:
7373

7474
::
7575

76-
$ cabal v2-build package-tests
76+
$ cabal build package-tests
7777

7878
Targets can be qualified with package names. So to request
7979
``package-tests`` *from* the ``Cabal`` package, use
8080
``Cabal-tests:package-tests``.
8181

8282
Unlike sandboxes, there is no need to setup a sandbox or ``add-source``
8383
projects; just check in ``cabal.project`` to your repository and
84-
``v2-build`` will just work.
84+
``build`` will just work.
8585

8686
Cookbook
8787
========
@@ -94,14 +94,14 @@ line::
9494

9595
profiling: True
9696

97-
Now, ``cabal v2-build`` will automatically build all libraries and
97+
Now, ``cabal build`` will automatically build all libraries and
9898
executables with profiling. You can fine-tune the profiling settings
9999
for each package using :cfg-field:`profiling-detail`::
100100

101101
package p
102102
profiling-detail: toplevel-functions
103103

104-
Alternately, you can call ``cabal v2-build --enable-profiling`` to
104+
Alternately, you can call ``cabal build --enable-profiling`` to
105105
temporarily build with profiling.
106106

107107
How can I have a reproducible set of versions for my dependencies?
@@ -173,13 +173,13 @@ built version.
173173
The global package store is ``~/.cabal/store`` (configurable via
174174
global `store-dir` option); if you need to clear your store for
175175
whatever reason (e.g., to reclaim disk space or because the global
176-
store is corrupted), deleting this directory is safe (``v2-build``
176+
store is corrupted), deleting this directory is safe (``build``
177177
will just rebuild everything it needs on its next invocation).
178178

179179
This split motivates some of the UI choices for Nix-style local build
180-
commands. For example, flags passed to ``cabal v2-build`` are only
180+
commands. For example, flags passed to ``cabal build`` are only
181181
applied to *local* packages, so that adding a flag to
182-
``cabal v2-build`` doesn't necessitate a rebuild of *every* transitive
182+
``cabal build`` doesn't necessitate a rebuild of *every* transitive
183183
dependency in the global package store.
184184

185185
In cabal-install 2.0 and above, Nix-style local builds also take advantage of a
@@ -194,10 +194,10 @@ are not currently built on a per-component basis.
194194
Where are my build products?
195195
----------------------------
196196

197-
A major deficiency in the current implementation of v2-build is that
197+
A major deficiency in the current implementation of build is that
198198
there is no programmatic way to access the location of build products.
199199
The location of the build products is intended to be an internal
200-
implementation detail of v2-build, but we also understand that many
200+
implementation detail of build, but we also understand that many
201201
unimplemented features can only be reasonably worked around by
202202
accessing build products directly.
203203

@@ -245,7 +245,7 @@ the time it takes to execute a rebuild cycle. While the details of how
245245
``cabal-install`` does caching are an implementation detail and may
246246
change in the future, knowing what gets cached is helpful for
247247
understanding the performance characteristics of invocations to
248-
``v2-build``. The cached intermediate results are stored in
248+
``build``. The cached intermediate results are stored in
249249
``dist-newstyle/cache``; this folder can be safely deleted to clear the
250250
cache.
251251

@@ -261,7 +261,7 @@ this folder (the most important two are first):
261261
already available in the store.)
262262
``source-hashes`` (binary)
263263
The hashes of all local source files. When all local source files of
264-
a local package are unchanged, ``cabal v2-build`` will skip
264+
a local package are unchanged, ``cabal build`` will skip
265265
invoking ``setup build`` entirely (saving us from a possibly
266266
expensive call to ``ghc --make``). The full list of source files
267267
participating in compilation is determined using

0 commit comments

Comments
 (0)