Skip to content

Commit 16f11ab

Browse files
committed
Add note about how Stack checks packages for sdist/upload
1 parent 6374ffa commit 16f11ab

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

doc/commands/sdist_command.md

+6
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,9 @@ By default:
3939
For futher information, see the
4040
[`pvp-bounds`](../configure/yaml/non-project.md#pvp-bounds) non-project
4141
specific configuration option documentation.
42+
43+
!!! note
44+
45+
Stack checks a package for common mistakes using checks provided by Cabal
46+
(the library). The version of Cabal used by Stack to check may be
47+
older than the version used by Stack to build.

doc/commands/upload_command.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ uploads the package to Hackage.
4343

4444
By default:
4545

46-
* the command will check each package for common mistakes. Pass the flag
47-
`--ignore-check` to disable such checks;
46+
* the command will check each package for common mistakes. For further
47+
information, see the [`stack sdist` command](sdist_command.md) documentation.
48+
Pass the flag `--ignore-check` to disable such checks; and
4849

4950
* Stack will not test the resulting package archive. Pass the flag
5051
`--test-tarball` to cause Stack to test each resulting package archive, by

0 commit comments

Comments
 (0)