aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/common-utils/NOTES.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/common-utils/NOTES.md b/src/common-utils/NOTES.md
index e9b2713..f2c7aa7 100644
--- a/src/common-utils/NOTES.md
+++ b/src/common-utils/NOTES.md
@@ -2,6 +2,11 @@
This Feature should work on recent versions of Debian/Ubuntu, RedHat Enterprise Linux, Fedora, RockyLinux, and Alpine Linux.
+## Using with dev container images
+
+This Feature is used in many of the [dev container images](https://github.com/search?q=repo%3Adevcontainers%2Fimages+%22ghcr.io%2Fdevcontainers%2Ffeatures%2Fcommon-utils%22&type=code), as a result
+these images have already allocated UID & GID 1000. Attempting to add this Feature with UID 1000 and/or GID 1000 on top of such a dev container image will result in an error when building the dev container.
+
## Customizing the command prompt
By default, this script provides a custom command prompt that includes information about the git repository for the current folder. However, with certain large repositories, this can result in a slow command prompt due to the performance of needed git operations.