psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-21 22:21:08 -05:00
Code Issues Releases Wiki Activity

Alt and default template comparsions are case-insensitive

Browse source 
Also mention that distro and distro family can be overridden.
This commit is contained in:
Erik Flodin 2024-12-10 21:23:50 +01:00
parent 89a70beb3f
commit 4a4f8c4651
No known key found for this signature in database
GPG key ID: 420A7C865EE3F85F
2 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
_docs/060_alternates.md
View file

@ -23,15 +23,16 @@ commas.
Each condition is an attribute/value pair, separated by a period. Some Each condition is an attribute/value pair, separated by a period. Some
conditions do not require a "value", and in that case, the period and value can conditions do not require a "value", and in that case, the period and value can
be omitted. Most attributes can be abbreviated as a single letter. be omitted. Most attributes can be abbreviated as a single letter. Values are
compared case-insensitive.
| Attribute | Meaning | | Attribute | Meaning |
| - | - | | - | - |
| `arch`, `a` | Valid if the value matches the architecture. Architecture is calculated by running <code>uname&nbsp;&#8209;m</code>. | | `arch`, `a` | Valid if the value matches the architecture. Architecture is calculated by running <code>uname&nbsp;&#8209;m</code>. |
| `class`, `c` | Valid if the value matches the local.class configuration. Class must be manually set using <code>yadm&nbsp;config&nbsp;local.class&nbsp;&lt;class&gt;</code>. | | `class`, `c` | Valid if the value matches the local.class configuration. Class must be manually set using <code>yadm&nbsp;config&nbsp;local.class&nbsp;&lt;class&gt;</code>. |
| `default` | Valid when no other alternate is valid. | | `default` | Valid when no other alternate is valid. |
| `distro`, `d` | Valid if the value matches the distro. Distro is calculated by running <code>lsb_release&nbsp;&#8209;si</code> or inspecting <code>/etc/os-release</code> | | `distro`, `d` | Valid if the value matches the distro. Distro is calculated by running <code>lsb_release&nbsp;&#8209;si</code> or inspecting `ID` from <code>/etc/os-release</code> |
| `distro_family`, `f` | Valid if the value matches the distro family. Distro family is calculated by inspecting the `ID_LIKE` line from <code>/etc/os-release</code> | | `distro_family`, `f` | Valid if the value matches the distro family. Distro family is calculated by inspecting `ID_LIKE` from <code>/etc/os-release</code> (or `ID` if `ID_LIKE` isn't found) |
| `extension`, `e` | A special "condition" that doesn't affect the selection process. Its purpose is instead to allow the alternate file to end with a certain extension to e.g. make editors highlight the content properly. | | `extension`, `e` | A special "condition" that doesn't affect the selection process. Its purpose is instead to allow the alternate file to end with a certain extension to e.g. make editors highlight the content properly. |
| `hostname`, `h` | Valid if the value matches the short hostname. Hostname is calculated by running <code>uname&nbsp;&#8209;n</code>, and trimming off any domain. | | `hostname`, `h` | Valid if the value matches the short hostname. Hostname is calculated by running <code>uname&nbsp;&#8209;n</code>, and trimming off any domain. |
| `os`, `o` | Valid if the value matches the OS. OS is calculated by running <code>uname&nbsp;&#8209;s</code>. <sup>*</sup> | | `os`, `o` | Valid if the value matches the OS. OS is calculated by running <code>uname&nbsp;&#8209;s</code>. <sup>*</sup> |
@ -43,9 +44,6 @@ The OS for "Windows Subsystem for Linux" is reported as "WSL", even though uname
<br/> <br/>
* *
The OS for Linux-like runtimes for Windows (e.g. MinGW, Cygwin) is obtained by running `uname -o`. The OS for Linux-like runtimes for Windows (e.g. MinGW, Cygwin) is obtained by running `uname -o`.
<br/>
*
If `lsb_release` is not available, "distro" will be the ID specified in `/etc/os-release`.
</sup></sub> </sup></sub>
You may use any number of conditions, in any order. An alternate will only be You may use any number of conditions, in any order. An alternate will only be
@ -117,9 +115,10 @@ yadm configuration—with the `yadm config` command. The following sets the
yadm config local.class Work yadm config local.class Work
Similarly, the values of `arch`, `os`, `hostname`, and `user` can be manually Similarly, the values of `arch`, `os`, `hostname`, `user`, `distro`, and
overridden using the configuration options `local.arch`, `local.os`, `distro_family` can be manually overridden using the configuration options
`local.hostname`, and `local.user`. `local.arch`, `local.os`, `local.hostname`, `local.user`, `local.distro`, and
`local.distro-family`.
Additional local classes can be defined using the `--add` switch. Additional local classes can be defined using the `--add` switch.

2
_docs/070_templates.md
View file

@ -100,7 +100,7 @@ variable. Only equality can be tested. These blocks must start with
block can also be specified using the directive `{% else %}`. These directives block can also be specified using the directive `{% else %}`. These directives
must appear on lines by themselves. They may not appear on the same line. The must appear on lines by themselves. They may not appear on the same line. The
"if" directive only supports testing a single variable, and there is no "elif" "if" directive only supports testing a single variable, and there is no "elif"
directive as there is in Jinja. directive as there is in Jinja. Comparisions are done case-insensitive.
<br><br> <br><br>
If multiple classes are defined, `yadm.class=="someclass"` will be true if *any* If multiple classes are defined, `yadm.class=="someclass"` will be true if *any*
of the defined classes are "someclass". of the defined classes are "someclass".