Skip to content

Commit 3e5c270

Browse files
committed
Re commercialhaskell#6497 Add documentation to stack upgrade
1 parent 11908c0 commit 3e5c270

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/upgrade_command.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ or:
1616
stack upgrade [--source-only] [--git] [--git-repo ARG] [--git-branch ARG]
1717
~~~
1818

19-
`stack upgrade` will get a new version of Stack.
19+
`stack upgrade` will get a new version of Stack. It can also get a version
20+
before the current version (downgrade).
21+
22+
!!! warning
23+
24+
If you use GHCup to install Stack, use only GHCup to upgrade Stack.
2025

2126
By default:
2227

@@ -65,6 +70,13 @@ When compiling from source code, by default:
6570
`--git-branch <branch>` to specify a different branch and the option
6671
`--git-repo <repo_url>` to specify a different repository).
6772

73+
!!! note
74+
75+
An earlier version of Stack could be inconsistent with some of the current
76+
contents of the Stack root. For further information about the contents of
77+
the Stack root and configuring its location, see the documentation about the
78+
[Stack root](stack_root.md).
79+
6880
## Examples
6981

7082
* `stack upgrade` seeks an upgrade to the latest version of Stack available as a

0 commit comments

Comments
 (0)