aboutsummaryrefslogtreecommitdiff
path: root/src/common-utils
diff options
context:
space:
mode:
authorChuck Lantz <clantz@microsoft.com>2022-08-11 23:11:00 +0300
committerGitHub <noreply@github.com>2022-08-11 23:11:00 +0300
commit29e25a77b03c0c8d34c612a74adffb2362af2bff (patch)
tree79ac107a58ba980e03a8dd869c4fc57406fd6aee /src/common-utils
parentf8396a6c3531a3a307f5f9d1d3adf065baa7a5a6 (diff)
Add notes for Features that have them (#88)
Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com>
Diffstat (limited to 'src/common-utils')
-rw-r--r--src/common-utils/NOTES.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/common-utils/NOTES.md b/src/common-utils/NOTES.md
new file mode 100644
index 0000000..2c07245
--- /dev/null
+++ b/src/common-utils/NOTES.md
@@ -0,0 +1,12 @@
+## 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.
+