aboutsummaryrefslogtreecommitdiff
path: root/src/common-utils/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/common-utils/README.md')
-rw-r--r--src/common-utils/README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/common-utils/README.md b/src/common-utils/README.md
index e6e66f5..e98b9e4 100644
--- a/src/common-utils/README.md
+++ b/src/common-utils/README.md
@@ -25,6 +25,20 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r
| gid | Enter gid for non-root user | string | automatic |
| nonFreePackages | Add packages from non-free Debian repository? | boolean | - |
+## Speeding up the command prompt in large repositories
+
+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 since the required git status command can be slow. To resolve this, you can update a git setting to remove the git portion of the command prompt.
+
+To disable the prompt for the current folder's repository, enter the following in a terminal or add it to your `postCreateCommand` or dotfiles:
+
+```bash
+git config codespaces-theme.hide-status 1
+```
+
+This setting will survive a rebuild since it is applied to the repository rather than the container.
+
+
+
---
-_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/common-utils/devcontainer-feature.json)._
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/common-utils/devcontainer-feature.json). Add additional notes to a `NOTES.md`._