diff options
| author | pennae <github@quasiparticle.net> | 2022-08-29 18:01:47 +0200 |
|---|---|---|
| committer | pennae <github@quasiparticle.net> | 2022-08-31 16:21:10 +0200 |
| commit | 9c3c13b50d02380cda1c834bc15cff3346956ea4 (patch) | |
| tree | 3a0c8e1a1319664ec7daf67f7ccc76965a0db32d /doc | |
| parent | 9bb82c35b750b5ffdebb906b696b135ef028b4f6 (diff) | |
nixos/make-options-doc: add inline roles for varname/envar
both of these render distinctly from plain literals in the manpage, and manpages even semantically distinguish between the two.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua | 4 | ||||
| -rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 4 |
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua b/doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua index 1c745393a04b4..5c1b034d0792d 100644 --- a/doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua +++ b/doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua @@ -31,6 +31,10 @@ function Code(elem) tag = 'command' elseif elem.attributes['role'] == 'option' then tag = 'option' + elseif elem.attributes['role'] == 'var' then + tag = 'varname' + elseif elem.attributes['role'] == 'env' then + tag = 'envar' end if tag ~= nil then diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index db16f13b474b8..81482523cd0ec 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -58,8 +58,10 @@ Additional syntax extensions are available, though not all extensions can be use A few markups for other kinds of literals are also available: - `` {command}`rm -rfi` `` turns into {command}`rm -rfi` - - `` {option}`networking.useDHCP` `` turns into {option}`networking.useDHCP` + - `` {env}`XDG_DATA_DIRS` `` turns into {env}`XDG_DATA_DIRS` - `` {file}`/etc/passwd` `` turns into {file}`/etc/passwd` + - `` {option}`networking.useDHCP` `` turns into {option}`networking.useDHCP` + - `` {var}`/etc/passwd` `` turns into {var}`/etc/passwd` These literal kinds are used mostly in NixOS option documentation. |