mirrors/jj
1
0
Fork 0
mirror of https://github.com/jj-vcs/jj.git synced 2025-12-23 06:01:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

cli config list docs: explain config key format in templates

Browse source 
This also means that this field should not become a `List<String>`,
though it would make sense to create a new type for it (which could be
converted into `List<String>` in two different ways, with or without
quoting).
This commit is contained in:
Ilya Grigoriev 2025-12-21 23:39:02 -08:00 • committed by Ilya Grigoriev
parent 513c5f7b3c
commit b2792e190b
2 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
cli/src/commands/config/list.rs
View file

@ -49,7 +49,7 @@ pub struct ConfigListArgs {
///
/// The following keywords are available in the template expression:
///
/// * `name: String`: Config name.
/// * `name: String`: Config name, in [TOML's "dotted key" format].
/// * `value: ConfigValue`: Value to be formatted in TOML syntax.
/// * `overridden: Boolean`: True if the value is shadowed by other.
/// * `source: String`: Source of the value.
@ -61,6 +61,8 @@ pub struct ConfigListArgs {
///
/// See [`jj help -k templates`] for more information.
///
/// [TOML's "dotted key" format]: https://toml.io/en/v1.0.0#keys
///
/// [`jj help -k templates`]:
/// https://docs.jj-vcs.dev/latest/templates/
#[arg(

4
cli/tests/cli-reference@.md.snap
View file

@ -731,7 +731,7 @@ List variables set in config files, along with their values
The following keywords are available in the template expression:
* `name: String`: Config name.
* `name: String`: Config name, in [TOML's "dotted key" format].
* `value: ConfigValue`: Value to be formatted in TOML syntax.
* `overridden: Boolean`: True if the value is shadowed by other.
* `source: String`: Source of the value.
@ -743,6 +743,8 @@ List variables set in config files, along with their values
See [`jj help -k templates`] for more information.
[TOML's "dotted key" format]: https://toml.io/en/v1.0.0#keys
[`jj help -k templates`]:
https://docs.jj-vcs.dev/latest/templates/