commit 5702eeb4da6f2b30bd2b75187cecd240b4ee5dc7
author Rob Mohr <mohrr@google.com> Thu Jan 20 14:05:31 2022 -0800
committer CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Fri Jan 21 00:42:35 2022 +0000
tree ab946b5ac66880556a08f687f960b7fcb1034dde
parent 4adef6fa36c9f9222165e35cadb9e92e3d99477e

pw_env_setup: Add README to environment directory

Change-Id: I77f4036d85c9a15e5a60bc0aafbed2020fe8b466
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/80580
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Reviewed-by: Alexei Frolov <frolv@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>

pw_env_setup/destination.md

diff --git a/pw_env_setup/destination.md b/pw_env_setup/destination.md
new file mode 100644
index 0000000..37a1b9a
--- /dev/null
+++ b/pw_env_setup/destination.md
@@ -0,0 +1,9 @@
+# Pigweed Environment Directory
+
+This is the directory into which Pigweed installed its environment. In general,
+it's acceptable to delete this entire directory, but don't delete any files
+within this directory without deleting the entire directory or there may be
+strange results.
+
+After deleting this directory, run `. bootstrap.sh` or `bootstrap.bat` instead
+of `. activate.sh` or `activate.bat`.

pw_env_setup/util.sh

diff --git a/pw_env_setup/util.sh b/pw_env_setup/util.sh
index 42c002a..d43c050 100644
--- a/pw_env_setup/util.sh
+++ b/pw_env_setup/util.sh
@@ -244,6 +244,8 @@
     "$_PW_PYTHON" "$PW_ROOT/pw_env_setup/py/pw_env_setup/env_setup.py" "$@"
     _PW_ENV_SETUP_STATUS="$?"
   fi
+
+  cp "$PW_ROOT/pw_env_setup/destination.md" "$_PW_ACTUAL_ENVIRONMENT_ROOT/README.md"
 }
 
 pw_activate() {