Commit Graph

31365 Commits

Author SHA1 Message Date
pennae
be6a25368f nixos-render-docs: init from optionsToDocbook.py
this new package shall eventually contain the rendering code necessary
to produce the entirety of the nixos (not nixpkgs) manual, in all of its
various output formats.
2023-01-27 20:07:33 +01:00
pennae
9ff987764c nixos/make-options-doc: enable smartquotes and replacements
the rest of the nixos manual has them enabled, so we should enable them
here too for consistency.

this changes rendered output pervasively. changes also include quotes in
types (eg in `strings concatenated with "\n"`), but since those are not
code this is probably fine. if not we can probably add a myst role to
inhibit replacements.
2023-01-26 00:38:06 +01:00
pennae
de22a26b4c nixos/make-options-doc: render option types through md
no changes to rendered output, but options.xml loses a few spaces.
2023-01-26 00:38:06 +01:00
pennae
6b677d9148 nixos/make-options-doc: disable inline html
we target not only html, but also manpages. inline html is not helpful
for the latter.
2023-01-26 00:38:06 +01:00
pennae
ba1f533134 nixos/make-option-docs: wrap md parser+renderer into Converter
the new rendering tool will consist of a number of different Converters,
each with a possibly specialized Renderer.
2023-01-26 00:38:06 +01:00
pennae
3e45994a3b nixos/make-options-doc: don't use inspect for optionsToDocbook
the rules are fixed, and we want to support all of them (or throw a
useful error message). this will also become the base for a generic
renderer system, so let's just list all the rules statically.
2023-01-26 00:38:06 +01:00
Robert Hensing
d255493e8f nixos/optionsToDocbook.py: Add docbook ns for when the appendix tag is omitted 2023-01-26 00:32:56 +01:00
pennae
617822c95b nixos/manual: remove olinkdb
as far as we can tell nixos has only ever had a total of one olink, and
currently has no olinks at all. we can't currently represent olinks in
markdown docs, and if we re-add support for cross-document links they
will take a different form (and not use docbook, which will have to be
phased out before we re-add anything).

the olinkdb is thus unused and takes 10 seconds on our machine to build,
holding up the rest of the manual for no benefit.
2023-01-26 00:32:56 +01:00
pennae
0175a91aa3 nixos/make-options-doc: split docbook conversion from mergeJSON
this restores mergeJSON to its former glory if…merging json, and
extracts the MD rendering into a new script that will run instead of the
py+nix+xslt pipeline we previously ran to convert options.json to docbook.

this change alone gives a noticable performance boost when building
docs (18s instead of 27s to build optionsDocBook).

no changes to rendered output, except for a single example in the
rsnapshot module that uses hard tabs for indentation instead of spaces.
this probably isn't important.

docbook warnings remain with mergeJSON since the other processing steps
output single files instead of directories. since we'll only keep the
check until 23.11 this is probably also not important to fix.

also contains a few improvements to error reporting in the MD renderers.
2023-01-26 00:32:56 +01:00
pennae
381dcd7f9d nixos/make-options-doc: remove program argument to xslt
this doesn't seem to be set anywhere, not from make-options-doc nor
anywhere else.
2023-01-26 00:32:56 +01:00
Ryan Lahfa
8803f1da66
Merge pull request #178290 from andrew-hoff/ahh/qemu-interfaces
nixos/virtualisation: add option for explicitly named network interfaces
2023-01-25 17:32:53 +01:00
Nick Cao
d469096dbd
nixos/fwupd: do no use renamed options in tests 2023-01-25 13:37:00 +08:00
Bobby Rong
776cc63480
Merge pull request #212210 from bobby285271/rm/gnome-documents
nixos/gnome-documents: remove
2023-01-25 11:04:08 +08:00
Jörg Thalheim
9ccde6dcca
Merge pull request #212268 from Mic92/tpm-crb-riscv64
disable tpm-crb on riscv64
2023-01-24 22:05:45 +00:00
Yurii Izorkin
e673e90753
nixos/no-x-libs: add qtbase (#212460)
Previously, `services.murmur.enable` would not work with `environment.noXlibs = true;`.
2023-01-24 23:31:59 +02:00
Sandro
17631ae82d
Merge pull request #208712 from mattmelling/cloudlog
cloudlog: init at 2.3
2023-01-24 02:52:36 +01:00
Sandro
ad2c56acb3
Merge pull request #212133 from mdarocha/remove-dotnet-5
dotnet-sdk_5: remove package
2023-01-24 02:51:10 +01:00
Sandro
deeba2fb9e
Merge pull request #206257 from matklad/throttledup 2023-01-23 23:54:18 +01:00
Matt Melling
c281dd3e05
nixos/cloudlog: init 2023-01-23 22:41:07 +00:00
Sandro
d105aed7f5
Merge pull request #210435 from Stunkymonkey/activemq-broker-phases 2023-01-23 23:37:51 +01:00
Sandro
e3d6edd75f
Merge pull request #209045 from Izorkin/update-dhcpcd-ipv6rs 2023-01-23 23:25:03 +01:00
Sandro
9cf61a285c
Merge pull request #206746 from georgyo/mastodon-secretenv 2023-01-23 23:07:57 +01:00
mdarocha
5234f4ce93 dotnet-sdk_5: remove package
It's EOL and not used in nixpkgs anymore
2023-01-23 19:16:58 +01:00
Bernardo Meurer
271dbd928e
nixos/blocky: restart on failure 2023-01-23 11:45:56 -05:00
Jörg Thalheim
86d5b67260 disable tpm-crb on riscv64 2023-01-23 15:00:41 +01:00
Maximilian Bosch
48665a4150
linux_6_0: drop
EOLed by upstream, doesn't receive any patches anymore, so let's drop
it.

Currently depends on #211886 which bumps the latest compatible ZFS
version to 6.1.

Also, clean up some old aliases.
2023-01-23 10:59:20 +01:00
Nick Cao
3cd694d1bd
Merge pull request #210382 from B4dM4n/nixos-rebuild-local
nixos-rebuild: Allow local builds when --target-host is used again
2023-01-23 16:37:41 +08:00
Nick Cao
a7a0d03ecc
Merge pull request #211229 from Luflosi/fix-modprobeConfig-typo
nixos/modprobe: fix typo in boot.modprobeConfig.enable documentation
2023-01-23 16:02:09 +08:00
Nick Cao
b9576dd927
Merge pull request #211723 from tpwrules/fix-systemd-boot-more
nixos/systemd-boot: fix tests and upgrade issues
2023-01-23 15:55:57 +08:00
Bobby Rong
00a6553266
nixos/gnome-documents: remove
We disabled this in gnome module starting from dcbad82
and the package was removed e84c8d6.
2023-01-23 11:59:57 +08:00
Bobby Rong
9d801f40e6
Merge pull request #211953 from bobby285271/upd/nixosTests.pantheon
nixosTests.pantheon: ensure switchboard starts + various changes
2023-01-23 10:05:46 +08:00
Julien Malka
808663bd02
nixos/uptime-kuma: add ping in path (#212001)
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2023-01-22 23:03:45 +01:00
Riey
0db47bd50e kime: 2.5.6 -> 3.0.2 2023-01-22 19:57:34 +01:00
Maximilian Bosch
ad6cd4173f
Merge pull request #211894 from chvp/grafana-image-renderer-use-module
nixos/grafana-image-renderer: use grafana freeform settings in provisioning
2023-01-22 19:06:35 +01:00
Andrew Hoff
6ae3e7695e nixos/virtualisation: add option for explicitly named network interfaces
Adds a new option to the virtualisation modules that enables specifying
explicitly named network interfaces in QEMU VMs. The existing
`virtualisation.vlans` is still supported for cases where the name of
the network interface is irrelevant.
2023-01-22 12:20:40 -05:00
Ryan Lahfa
04bf8215a9
Merge pull request #209075 from symphorien/nginx-validate-config-revert
nixos/nginx: revert config validation
2023-01-22 17:57:46 +01:00
pennae
e2019c49d4 nixos/make-options-doc: use markdown-it-py for rendering
only whitespace changes (mostly empty descriptions rendered as literal
line breaks and trailing space toPretty generates, but that were dropped
by mistune).
2023-01-22 17:50:09 +01:00
pennae
248e1b957d nixos/make-options-doc: render related packages with md
don't generate docbook for related packages, generate markdown instead.
this could be extended further to not even generate markdown but have
mergeJSON handle all of the rendering. markdown will work fine for now
though.
2023-01-22 17:50:09 +01:00
pennae
fa8a594c56 nixos/make-options-doc: deprecate \n\n parbreak
only whitespace changes to rendered outputs, all in the vicinity or body
of admonitions. previously admonitions would not receive paragraph
breaks even when they should have because the description postprocessing
did not match on their contents.
2023-01-22 17:50:09 +01:00
pennae
c93e5dde67 nixos/make-options-doc: rearrange paras in related packages/defaults/examples
this mirrors what we will be able to create with markdown. no change to
rendered outputs.
2023-01-22 17:50:09 +01:00
pennae
3a5f1ae029 nixos/make-options-doc: render default/example contents through MD
removes some trailing whitespaces from the html output, no other changes.
2023-01-22 17:50:09 +01:00
pennae
2bd8129a47 nixos/make-options-doc: make whitespace more md-compatible
markdown-it-py creates different whitespace leaders/trailers than are
currently emitted, and when we convert examples and defaults to render
via markdown the spacing will change too. this has no effect on rendered
output.
2023-01-22 17:50:09 +01:00
pennae
d1aa187c0e nixos/make-options-doc: don't escape link urls twice
mistune already does escaping. it does escaping for html, but the
difference is small enough that can just ignore that we're actually
targeting docbook here.
2023-01-22 17:50:09 +01:00
pennae
2cb43da587 nixos/make-options-doc: remove trailing whitespace from strings
this was done only to make the conversion to MD easier to verify. we no
longer need it, and not keeping whitespace does not affect rendered outputs.

stripping will have to stay for now because description postprocessing
would add empty paragraphs otherwise.
2023-01-22 17:50:09 +01:00
pennae
e067d9e33e nixos/redsocks: fix option description formatting 2023-01-22 17:50:09 +01:00
pennae
cf792cfde3 nixos/envfs: fix envfs package option default
mdDoc is not valid here, but isn't currently rejected for xslt reasons.
2023-01-22 17:50:09 +01:00
Julien Malka
85c34d334b nixos/uptime-kuma: add julienmalka as maintainer 2023-01-22 17:39:22 +01:00
Xavier Lambein
3f3524a447 nixos/autosuspend: init at version 4.3.0
`autosuspend` is a daemon that periodically runs user-defined checks to
verify whether the system should be suspended.  It's already available
in nixpkgs.  This adds a NixOS module which starts the daemon as a
systemd service.

Co-authored-by: pennae <82953136+pennae@users.noreply.github.com>
2023-01-22 17:25:01 +01:00
pennae
ad8d5cf731 nixos/manual: clarify mk{Enable,Package}Option MD usage
the examples were incorrect, but not catastrophically. running a docs
build would've issued a warning with the correct instructions.
2023-01-22 17:08:40 +01:00
pennae
df09c21fb2 nixos/documentation: deprecate docbook option docs
following the plan in https://github.com/NixOS/nixpkgs/pull/189318#discussion_r961764451

also adds an activation script to print the warning during activation
instead of during build, otherwise folks using the new CLI that hides
build logs by default might never see the warning.
2023-01-22 17:08:40 +01:00