Skip to content

Commit a3dc31d

Browse files
github-actions[bot]github-actions
andauthored
Automated documentation update (devcontainers#338)
Automated documentation update [skip ci] Co-authored-by: github-actions <github-actions@github.com>
1 parent bf058dc commit a3dc31d

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

src/common-utils/README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
# Common Debian Utilities (common-utils)
2+
# Common Utilities (common-utils)
33

44
Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-root user.
55

66
## Example Usage
77

88
```json
99
"features": {
10-
"ghcr.io/devcontainers/features/common-utils:1": {}
10+
"ghcr.io/devcontainers/features/common-utils:2": {}
1111
}
1212
```
1313

@@ -19,24 +19,32 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r
1919
| configureZshAsDefaultShell | Change default shell to ZSH? | boolean | false |
2020
| installOhMyZsh | Install Oh My Zsh!? | boolean | true |
2121
| upgradePackages | Upgrade OS packages? | boolean | true |
22-
| username | Enter name of non-root user to configure or none to skip | string | automatic |
23-
| uid | Enter uid for non-root user | string | automatic |
24-
| gid | Enter gid for non-root user | string | automatic |
25-
| nonFreePackages | Add packages from non-free Debian repository? | boolean | false |
22+
| username | Enter name of a non-root user to configure or none to skip | string | automatic |
23+
| userUid | Enter UID for non-root user | string | automatic |
24+
| userGid | Enter GID for non-root user | string | automatic |
25+
| nonFreePackages | Add packages from non-free Debian repository? (Debian only) | boolean | false |
2626

27-
## Speeding up the command prompt in large repositories
27+
## OS Support
2828

29-
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.
29+
This Feature should work on recent versions of Debian/Ubuntu, RedHat Enterprise Linux, Fedora, RockyLinux, and Alpine Linux.
3030

31-
To disable the prompt for the current folder's repository, enter the following in a terminal or add it to your `postCreateCommand` or dotfiles:
31+
## Customizing the command prompt
32+
33+
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.
34+
35+
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`:
3236

3337
```bash
34-
git config codespaces-theme.hide-status 1
38+
git config devcontainers-theme.show-dirty 1
3539
```
3640

37-
This setting will survive a rebuild since it is applied to the repository rather than the container.
41+
To completely disable the git portion of the prompt for the current folder's repository, you can use this configuration setting instead:
3842

43+
```bash
44+
git config devcontainers-theme.hide-status 1
45+
```
3946

47+
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`.
4048

4149
---
4250

0 commit comments

Comments
 (0)