Skip to content

Commit 901a6b4

Browse files
committed
Conform format of online documentation
1 parent 87f1c1c commit 901a6b4

File tree

4 files changed

+28
-15
lines changed

4 files changed

+28
-15
lines changed

doc/run_command.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,21 @@ Everything after `--` on the command line is interpreted as a command line
1717
argument to be passed to what is run, other than a first argument recognised as
1818
an executable target.
1919

20-
By default, the `GHC_PACKAGE_PATH` environment variable is set for the
21-
subprocess. Pass the `--no-ghc-package-path` flag to not set the variable.
20+
By default:
2221

23-
By default, the `STACK_EXE` environment variable is set with the path to Stack.
24-
Pass the `--no-stack-exe` flag to not set the variable.
22+
* the `GHC_PACKAGE_PATH` environment variable is set for the subprocess. Pass
23+
the `--no-ghc-package-path` flag to not set the variable; and
24+
25+
* the `STACK_EXE` environment variable is set with the path to Stack. Pass the
26+
`--no-stack-exe` flag to not set the variable.
2527

2628
The `--cwd` option can be used to set the working directory before the
2729
executable is run.
2830

31+
The `--package` option (which can be specified multiple times) can be used to
32+
add a package name to build targets.
33+
2934
The `--rts-options` option (which can be specified multiple times) can be used
3035
to pass a list of GHC's
3136
[runtime system (RTS) options](https://downloads.haskell.org/~ghc/latest/docs/users_guide/runtime_control.html#)
3237
to the executable when it is run. (The `+RTS` and `-RTS` must not be included.)
33-
34-
The `--package` option (which can be specified multiple times) can be used to
35-
add a package name to build targets.

doc/unpack_command.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,12 @@ stack unpack PACKAGE [--to ARG]
88

99
`stack unpack` downloads a tarball for the specified package and unpacks it.
1010

11-
Pass the option `--to <directory>` to specify the destination directory.
11+
By default:
12+
13+
* the download is for the most recent version of the package in the package
14+
index (eg Hackage). Specify the package name and its version (for example,
15+
`acme-missiles-0.1.0.0`) for a particular version of the package; and
16+
17+
* the package is unpacked into a directory named after the package and its
18+
version. Pass the option `--to <directory>` to specify the destination
19+
directory.

doc/upgrade_command.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,8 @@ binary distribution (pass the `--binary-only` flag, the default) or from
2020
compiling source code (pass the `--source-only` flag). The `--binary-only` and
2121
`--source-only` flags are alternatives.
2222

23-
`--git` is a convenient way to get the most recent version from the `master`
24-
branch, for those testing and living on the bleeding edge.
23+
When compiling from source code, by default:
24+
25+
* Stack will obtain the source code for the most recent version in the package
26+
index (eg Hackage). Pass the flag `--git` to specify the most recent version
27+
from the `master` branch of Stack's repository.

doc/upload_command.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,17 @@ example:
6868
stack upload .
6969
~~~
7070

71-
## The `stack upload --candidate` flag
71+
## `--candidate` flag
7272

7373
Pass the flag to upload a
7474
[package candidate](http://hackage.haskell.org/upload#candidates).
7575

76-
## The `stack upload --ignore-check` flag
76+
## `--ignore-check` flag
7777

7878
Pass the flag to disable checks of the package for common mistakes. By default,
7979
the command will check the package for common mistakes.
8080

81-
## The `stack upload --pvp-bounds` option
81+
## `--pvp-bounds` option
8282

8383
The `--pvp-bounds <pvp_bounds_mode>` option determines whether and, if so, how
8484
PVP version bounds should be added to the Cabal file of the package. The
@@ -89,12 +89,12 @@ available modes for use with Cabal file revisions are `lower-revision`,
8989
For futher information, see the
9090
[YAML configuration](yaml_configuration.md#pvp-bounds) documentation.
9191

92-
## The `stack upload --tar-dir` option
92+
## `--tar-dir` option
9393

9494
The `--tar-dir <path_to_directory>` option determines whether the package
9595
archive should be copied to the specified directory.
9696

97-
## The `stack upload --[no-]test-tarball` flag
97+
## `--[no-]test-tarball` flag
9898

9999
Default: Disabled
100100

0 commit comments

Comments
 (0)