diff options
| author | Chuck Lantz <clantz@microsoft.com> | 2022-12-16 20:47:21 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-16 20:47:21 +0300 |
| commit | bf058dc49492b3a102a28ed25764a517fcebfb40 (patch) | |
| tree | 6ccc831064fab57ea6fa2f0c530202ac0d73ff08 /src/common-utils/NOTES.md | |
| parent | 7fa90110d762797cc0b1c2fe8fcc028c9b813d56 (diff) | |
Multi-distro support for common script, refactor, fixes (#326)
Diffstat (limited to 'src/common-utils/NOTES.md')
| -rw-r--r-- | src/common-utils/NOTES.md | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/src/common-utils/NOTES.md b/src/common-utils/NOTES.md index 2c07245..77dfd1d 100644 --- a/src/common-utils/NOTES.md +++ b/src/common-utils/NOTES.md @@ -1,12 +1,21 @@ -## Speeding up the command prompt in large repositories +## OS Support -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. +This Feature should work on recent versions of Debian/Ubuntu, RedHat Enterprise Linux, Fedora, RockyLinux, and Alpine Linux. -To disable the prompt for the current folder's repository, enter the following in a terminal or add it to your `postCreateCommand` or dotfiles: +## 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. + +For performance reasons, a "dirty" indicator that tells you whether or not there are uncommitted changes is disabled by default. You can opt to turn this on for smaller repositories by entering the following in a terminal or adding it to your `postCreateCommand`: ```bash -git config codespaces-theme.hide-status 1 +git config devcontainers-theme.show-dirty 1 ``` -This setting will survive a rebuild since it is applied to the repository rather than the container. +To completely disable the git portion of the prompt for the current folder's repository, you can use this configuration setting instead: + +```bash +git config devcontainers-theme.hide-status 1 +``` +For `zsh`, the default theme is a [standard Oh My Zsh! theme](https://ohmyz.sh/). You may pick a different one by modifying the `ZSH_THEME` variable in `~/.zshrc`.
\ No newline at end of file |