movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 19:13:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/make-options-doc: add inline roles for varname/envar

Browse source 
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
This commit is contained in:
pennae 2022-08-29 18:01:47 +02:00
parent 9bb82c35b7
commit 9c3c13b50d
3 changed files with 26 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/contributing/contributing-to-documentation.chapter.md
View file

@ -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.