diff --git a/website/docs/segments/scm/fossil.mdx b/website/docs/segments/scm/fossil.mdx index b586c5f9..c4538fa1 100644 --- a/website/docs/segments/scm/fossil.mdx +++ b/website/docs/segments/scm/fossil.mdx @@ -22,9 +22,9 @@ import Config from '@site/src/components/Config.js'; ## Properties -| Name | Type | Default | Description | -| ----------------- | :-------: | :-----: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `native_fallback` | `boolean` | `false` | when set to `true` and `fossil.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native fossil executable to fetch data. Not all information can be displayed in this case | +| Name | Type | Default | Description | +| ----------------- | :-------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `native_fallback` | `boolean` | `false` | when set to `true` and `fossil.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native `fossil` executable to fetch data. Not all information can be displayed in this case | ## Template ([info][templates]) diff --git a/website/docs/segments/scm/git.mdx b/website/docs/segments/scm/git.mdx index fc98011b..25789d3a 100644 --- a/website/docs/segments/scm/git.mdx +++ b/website/docs/segments/scm/git.mdx @@ -58,7 +58,7 @@ You can set the following properties to `true` to enable fetching additional inf | `fetch_bare_info` | `boolean` | `false` | fetch bare repo info | | `untracked_modes` | `map[string]string` | | map of repo's where to override the default [untracked files mode][untracked]:For example `"untracked_modes": { "/Users/me/repos/repo1": "no" }` - defaults to `normal` for all repo's. If you want to override for all repo's, use `*` to set the mode instead of the repo path | | `ignore_submodules` | `map[string]string` | | map of repo's where to change the [--ignore-submodules][submodules] flag (`none`, `untracked`, `dirty` or `all`). For example `"ignore_submodules": { "/Users/me/repos/repo1": "all" }`. If you want to override for all repo's, use `*` to set the mode instead of the repo path | -| `native_fallback` | `boolean` | `false` | when set to `true` and `git.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native git executable to fetch data. Not all information can be displayed in this case | +| `native_fallback` | `boolean` | `false` | when set to `true` and `git.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native `git` executable to fetch data. Not all information can be displayed in this case | | `fetch_user` | [`User`](#user) | `false` | fetch the current configured user for the repository | | `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. | | `source` | `string` | `cli` | | diff --git a/website/docs/segments/scm/mercurial.mdx b/website/docs/segments/scm/mercurial.mdx index b97623b7..430044a6 100644 --- a/website/docs/segments/scm/mercurial.mdx +++ b/website/docs/segments/scm/mercurial.mdx @@ -33,10 +33,11 @@ import Config from "@site/src/components/Config.js"; As doing Mercurial (hg) calls can slow down the prompt experience, we do not fetch information by default. You can set the following properties to `true` to enable fetching additional information (and populate the template). -| Name | Type | Default | Description | -| ---------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fetch_status` | `boolean` | `false` | fetch the local changes | -| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | +| Name | Type | Default | Description | +| ----------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fetch_status` | `boolean` | `false` | fetch the local changes | +| `native_fallback` | `boolean` | `false` | when set to `true` and `hg.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native `hg` executable to fetch data. Not all information can be displayed in this case | +| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | ## Template ([info][templates]) diff --git a/website/docs/segments/scm/sapling.mdx b/website/docs/segments/scm/sapling.mdx index b4f6fea2..b7f1ac12 100644 --- a/website/docs/segments/scm/sapling.mdx +++ b/website/docs/segments/scm/sapling.mdx @@ -30,11 +30,11 @@ import Config from "@site/src/components/Config.js"; ### Fetching information -| Name | Type | Default | Description | -| ------------------- | :-----------------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fetch_status` | `boolean` | `true` | fetch the local changes - defaults to | -| `native_fallback` | `boolean` | `false` | when set to `true` and `sl.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native sapling executable to fetch data. Not all information can be displayed in this case | -| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | +| Name | Type | Default | Description | +| ----------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fetch_status` | `boolean` | `true` | fetch the local changes - defaults to | +| `native_fallback` | `boolean` | `false` | when set to `true` and `sl.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native `sl` executable to fetch data. Not all information can be displayed in this case | +| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | ## Template ([info][templates]) diff --git a/website/docs/segments/scm/svn.mdx b/website/docs/segments/scm/svn.mdx index a3ea604e..9c46fdeb 100644 --- a/website/docs/segments/scm/svn.mdx +++ b/website/docs/segments/scm/svn.mdx @@ -33,11 +33,11 @@ import Config from "@site/src/components/Config.js"; As doing multiple [subversion][svn] calls can slow down the prompt experience, we do not fetch information by default. You can set the following properties to `true` to enable fetching additional information (and populate the template). -| Name | Type | Default | Description | -| ------------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fetch_status` | `boolean` | `false` | fetch the local changes | -| `native_fallback` | `boolean` | `false` | when set to `true` and `svn.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native svn executable to fetch data. Not all information can be displayed in this case | -| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | +| Name | Type | Default | Description | +| ----------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fetch_status` | `boolean` | `false` | fetch the local changes | +| `native_fallback` | `boolean` | `false` | when set to `true` and `svn.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native `svn` executable to fetch data. Not all information can be displayed in this case | +| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides | :::info The fields `Repo`, `Branch` and `BaseRev` will still work with `fetch_status` set to `false`.