From cc34cf51f4f788c5286ff172ceeeb018464dcff6 Mon Sep 17 00:00:00 2001
From: Antoine Stevan <44101798+amtoine@users.noreply.github.com>
Date: Mon, 22 Aug 2022 20:08:56 +0200
Subject: [PATCH] FIX: `overlay remove` flags (#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
https://github.com/nushell/nushell.github.io/pull/565#discussion_r951221289

* remove a useless line in --keep-env paragraph

This commit addresses
https://github.com/nushell/nushell.github.io/pull/565#discussion_r951221500

* mention `--keep-env` flag in the related paragraph

This commit addresses
https://github.com/nushell/nushell.github.io/pull/565#discussion_r951693057

Co-authored-by: amtoine <44101798+AntoineStevan@users.noreply.github.com>
---
 book/overlays.md       | 20 ++++++++++++++++++--
 zh-CN/book/overlays.md |  4 ++--
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/book/overlays.md b/book/overlays.md
index 40f9c073649..552e62370b2 100644
--- 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
index 11fc847b1cb..5d6864421e7 100644
--- 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` 标志正是用来做这个的。
 
 ## 覆层顺序