diff options
| author | Samruddhi Khandale <skhandale@microsoft.com> | 2023-05-31 21:55:51 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-31 21:55:51 +0300 |
| commit | 852f1f0567280b465913b487d5f8c773122c36ab (patch) | |
| tree | 4582212e0e39e47c7d137459b9734e681e19c8c7 | |
| parent | cfae3b0f0d016f36229060b0e2abf5d55c9304e3 (diff) | |
Automated documentation update (#563)
Automated documentation update [skip ci]
Co-authored-by: github-actions <github-actions@github.com>
| -rw-r--r-- | src/common-utils/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/common-utils/README.md b/src/common-utils/README.md index 9102c95..1eddcbc 100644 --- a/src/common-utils/README.md +++ b/src/common-utils/README.md @@ -28,6 +28,11 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r 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. |