Skip to content

Commit 6be3b71

Browse files
committed
Add context for stack sdist command
Also documents some of its flags.
1 parent d1280e2 commit 6be3b71

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/GUIDE_advanced.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,17 @@ options for viewing only lts (`-l`) and nightly (`-n`) snapshots.
7575

7676
## The `stack sdist` command
7777

78-
`stack sdist` generates an uploading tarball containing your package code.
78+
Hackage only accepts packages for uploading in a standard form, a compressed
79+
archive ('tarball') in the format produced by Cabal's `sdist` action.
80+
81+
`stack sdist` generates an file for your package, in the format accepted by
82+
Hackage for uploads.
83+
84+
By default, the command will check the package for common mistakes. This can be
85+
disabled with the flag `--ignore-check`.
86+
87+
Setting the flag `--test-tarball` will cause Stack to attempt to build the
88+
resulting package, to test it.
7989

8090
## The `stack templates` command
8191

0 commit comments

Comments
 (0)