FIX: overlay remove flags (nushell#565)

* change "overlay remove"s --keep to --keep-custom * add an "overlay remove --keep-env" paragraph (EN) * rephrase the --keep-custom paragraph in overlays This commit addresses nushell#565 (comment) * remove a useless line in --keep-env paragraph This commit addresses nushell#565 (comment) * mention `--keep-env` flag in the related paragraph This commit addresses nushell#565 (comment) Co-authored-by: amtoine <[email protected]>
webwurst · Aug 22, 2022 · cc34cf5 · cc34cf5
1 parent 54f8270
commit cc34cf5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/book/overlays.md b/book/overlays.md
@@ -186,13 +186,29 @@ Sometimes, you might want to remove an overlay, but keep all the custom definiti
 
 (spam)> def eggs [] { "eggs" }
 
-(spam)> overlay remove --keep spam
+(spam)> overlay remove --keep-custom spam
 
 (zero)> eggs
 eggs
 ```
 
-The `--keep` flag does exactly that.
+The `--keep-custom` flag does exactly that.
+
+One can also keep a list of environment variables that were defined inside an overlay, but remove the rest, using the `--keep-env` flag:
+
+```
+(zero)> module spam { export def foo [] { "foo" }; export env FOO {"foo"}}
+
+(zero)> overlay add spam
+
+(spam)> overlay remove spam --keep-env [FOO]
+
+(zero)> foo
+Error: Can't run executable...
+
+(zero)> $env.FOO
+foo
+```
 
 ## Ordering Overlays
 

diff --git a/zh-CN/book/overlays.md b/zh-CN/book/overlays.md
@@ -154,13 +154,13 @@ _0.64 版本新增：_
 
 (spam)> def eggs [] { "eggs" }
 
-(spam)> overlay remove --keep spam
+(spam)> overlay remove --keep-custom spam
 
 (zero)> eggs
 eggs
 ```
 
-`--keep` 标志正是用来做这个的。
+`--keep-custom` 标志正是用来做这个的。
 
 ## 覆层顺序