Skip to content

Commit

Permalink
added warning to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tristanisham committed Jan 30, 2024
1 parent e690524 commit 8c41b87
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,9 @@ zvm help

```sh
-color # Turn ANSI color printing on or off for ZVM's output, i.e. -color=true
```
### BETA FLAGS: (Might not work as expected)
```sh
-vmu # Changes the version map url (good if you host your own Zig distrobution server).
# ZVM expects properly formatted URLs with the included protocol.
# URLs that don't serve workable JSON files will break ZVM. If you ever want to reset
Expand Down
2 changes: 2 additions & 0 deletions help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ help
------------- Flags -----------------
-color=<bool> | Turn color printing on or off for ZVM's output

BETA FLAGS: (Might not work as expected)

-vmu | Changes the version map url (Good if you host your own Zig distrobution server)
URLs that don't serve workable JSON files will break ZVM. If you ever want to reset
your version map url, just run -vmu default.
Expand Down
1 change: 1 addition & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ func main() {
flag.Parse()

if sVersionMapUrl != nil {
log.Warn("this is a beta flag, and may not behave as expected.")
if *sVersionMapUrl == "default" {
if err := zvm.Settings.ResetVersionMap(); err != nil {
log.Fatal(err)
Expand Down

0 comments on commit 8c41b87

Please # to comment.