Skip to content

Commit 21e47b2

Browse files
authored
docs: add missing information 0.16.0 upgrade instructions (#2103)
1 parent fc87e22 commit 21e47b2

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

docs/guide/upgrading-to-v0-16.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ a binary rather than a set of scripts.
88

99
## Installation
1010

11-
Installation of version 0.16.0 is much simpler than previous versions of asdf.
12-
It's just three steps:
11+
Installation of version 0.16.0 and newer is much simpler than previous versions
12+
of asdf. It's just three steps:
1313

1414
* Download the appropriate `asdf` binary for your operating system/architecture combo from the [GitHub releases page](https://github.com/asdf-vm/asdf/releases) and place it in a directory on your `$PATH`
1515
* Add `$ASDF_DATA_DIR/shims` to the front of your `$PATH`.
@@ -65,7 +65,28 @@ export ASDF_DATA_DIR="/home/myuser/.asdf"
6565
export PATH="$ASDF_DATA_DIR/shims:$PATH"
6666
```
6767

68-
#### 4. Regenerate Shims
68+
#### 4. Remove Old Config
69+
70+
In your shells RC file you'll have the old code running the asdf shell script at
71+
startup. It'll probably look something like this:
72+
73+
```
74+
. "$HOME/.asdf/asdf.sh"
75+
```
76+
77+
Or this:
78+
79+
```
80+
. /opt/homebrew/opt/asdf/libexec/asdf.sh
81+
```
82+
83+
Comment out these lines or remove them entirely.
84+
85+
If you are not using Zsh or Bash please see the legacy
86+
[Getting Started guide](https://asdf-vm.com/guide/getting-started-legacy.html#_3-install-asdf)
87+
for the code snippet you need to remove.
88+
89+
#### 5. Regenerate Shims
6990

7091
Verify that `asdf` command in your shell session is version 0.16.0+ by running
7192
`asdf --help`. If you still see an older version you will need to start a new
@@ -77,12 +98,12 @@ the old Bash version.
7798

7899
### Testing
79100

80-
81101
If you aren't sure if the upgrade to 0.16.0 will break things for you can you
82102
can test by installing 0.16.0 in addition to your existing version as described
83103
above in "Upgrading Without Losing Data". If it turns out that the upgrade to
84-
0.16.0 breaks things for you simply remove the lines you added to your shell
85-
RC file.
104+
0.16.0 or greater breaks things for you you can revert back to the older
105+
version. Remove the lines you added to your shell RC file, and add back in the
106+
lines you removed or commented out.
86107

87108
## Breaking Changes
88109

0 commit comments

Comments
 (0)