about summary refs log tree commit diff
path: root/nixos/doc/manual/development
AgeCommit message (Collapse)AuthorFilesLines
2024-04-09Merge pull request #284551 from hercules-ci/types-attrTagSilvan Mosberger1-16/+81
Add `types.attrTag`
2024-04-04doc/option-types: Update sum typesRobert Hensing1-5/+4
2024-04-04doc/option-types: Make attrTag example self-containedRobert Hensing1-14/+32
... well, except for the ellipses, which hide unnecessary descriptions, which you should write!
2024-04-04doc/option-types: Add attrTag exampleRobert Hensing1-0/+24
2024-04-01nixos/lib, doc: remove references to mdDoc (#300738)Philip Taron1-11/+8
* doc: remove references to mdDoc in nixos/doc/manual/development/option-declarations.section.md * nixos/lib: remove mdDoc in nixos/lib/make-options-doc/default.nix * nixos/lib: remove mdDoc in nixos/lib/systemd-types.nix * nixos/lib: remove mdDoc in nixos/lib/systemd-unit-options.nix * nixos/lib: remove mdDoc in nixos/lib/testing/driver.nix * nixos/lib: remove mdDoc in nixos/lib/testing/interactive.nix * nixos/lib: remove mdDoc in nixos/lib/testing/meta.nix * nixos/lib: remove mdDoc in nixos/lib/testing/name.nix * nixos/lib: remove mdDoc in nixos/lib/testing/network.nix * nixos/lib: remove mdDoc in nixos/lib/testing/nodes.nix * nixos/lib: remove mdDoc in nixos/lib/testing/run.nix * nixos/lib: remove mdDoc in nixos/lib/testing/testScript.nix
2024-03-28treewide: Fix all Nix ASTs in all markdown filesJanne Heß12-149/+205
This allows for correct highlighting and maybe future automatic formatting. The AST was verified to work with nixfmt only.
2024-03-12doc: Fix test in writing-nixos-tests.section.md (#294902)Anton Dyudin1-1/+1
* Fix test in writing-nixos-tests.section.md That paren couldn't possibly have been in the right place. (I do not have nix set up to generate `writing-nixos-tests.section.xml` or verify the test or anything, please do whatever is appropriate with this trivial change) * doc: fix numpy example test value Making the test test the right thing made it fail see PR discussion
2024-03-06Remove top level `with lib;` in docs (#293829)Philip Taron2-7/+3
2024-03-05nixos/doc/running-nixos-tests: Describe system requirementsRobert Hensing1-0/+10
2024-02-12pkgs.formats: toINIWithGlobalSection wrapperbenaryorg1-0/+28
The new format is based on the existing wrapper and generates an INI file with an unnamed global section at the top as is used by *stunnel* for instance. Technically the INI format is a subset of this however testing, type checking, and API guarantees profit from two separate generators. Co-authored-by: tim-tx <tim-tx@users.noreply.github.com> Signed-off-by: benaryorg <binary@benary.org>
2024-02-11doc/option-types: Move nullOr to Union typesRobert Hensing1-5/+5
2024-02-11doc/option-types: Move attrTag to Sum types, remove redundant paragraphRobert Hensing1-10/+4
2024-02-11doc/option-types: Move either and oneOf to Union typesRobert Hensing1-11/+10
2024-02-11doc/option-types: Write about sum and union typesRobert Hensing1-0/+21
2024-02-11lib.types.attrTag: initRobert Hensing1-0/+10
2024-02-10Merge pull request #284512 from hercules-ci/lib-types-unique-mergeSilvan Mosberger1-1/+1
lib.types.unique: Check inner type deeply
2024-01-29doc/option-types: Definitions are not declaredRobert Hensing1-1/+1
2024-01-25doc: Update manuals bespoke syntaxAlejandro Sanchez Medina1-63/+1
doc: add figure definition to bespoke syntax reference doc: add example definition to bespoke syntax reference doc: add footnote definition to beskpoke syntax reference The usage of footnotes in the manuals is not the one documented in markdown-it-py: https://python-markdown.github.io/extensions/footnotes/ doc: add inline comment definition to beskpoke syntax reference doc: add typographic replacements to beskpoke syntax reference doc: Fix rendering of bespoke syntax reference doc: remove references to DocBook in the NixOS manual doc: add entry on lack of HTML support doc: Minor improvement doc: update typographic replacements entry in beskpoke syntax reference doc: add link reference definitions to beskpoke syntax reference doc: fix footnote definition in beskpoke syntax reference doc: Minor improvements from code review Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-01-22nixos/etc: add manual sectionnikstur2-0/+37
2024-01-18switch-to-configuration: add sysinit-reactivation manual sectionnikstur1-0/+39
2024-01-18nixos/switch-to-configuration: add sysinit-reactivation.targetnikstur1-1/+1
2023-12-08lib.types.boolByOr: initSilvan Mosberger1-0/+7
This type is necessary to have correct merging behavior for `allowUnfreePredicate` and `allowInsecurePredicate` Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-11-29Revert "nixos/switch-to-configuration: remove explicit tmpfiles invocation"K9001-0/+1
2023-11-25nixos/switch-to-configuration: remove explicit tmpfiles invocationnikstur1-1/+0
2023-11-11Merge pull request #264442 from anthonyroussel/update-url-redirectsK9001-4/+4
treewide: fix redirected and broken URLs
2023-11-11manual: Fix QEMU_NET_OPTS VM-side address.Niklas Hambüchen1-1/+6
In my earlier commit manual: Don't suggest exposing VM port to local network. I made a side change titled Use `127.0.0.1` also on the VM side, otherwise connections to services that, in the VM, bind to `127.0.0.1` only (doing the safe approach) do not work. Unfortunately, that was wrong: QEMU inside the VM always communicates via the virtualised Ethernet interface, not via the VM's loopback interface. So trying to connect to `127.0.0.1` on the VM's side cannot work.
2023-11-11treewide: fix redirected and broken URLsAnthony Roussel1-4/+4
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-10manual: tests: Describe how to port-forward into test VMsNiklas Hambüchen1-0/+16
2023-11-09doc: avoid 'simply' (#266434)Arnout Engelen1-1/+1
While the word 'simply' is usually added to encourage readers, it often has the opposite effect and may even appear condescending, especially when the reader runs into trouble trying to apply the suggestions from the documentation. It is almost always an improvement to simply drop the word from the sentence. (there are more possible improvements like this, we can apply those in separate PRs)
2023-10-29Merge pull request #263462 from nikstur/rebuildable-systemRobert Hensing2-0/+22
Rebuildable system & appliance
2023-10-28nixos/docs: add non-switchable-systems sectionnikstur2-0/+22
2023-10-20Merge master into staging-nextgithub-actions[bot]1-0/+4
2023-10-20nixos/switch-to-configuration: Allow not filtering unitsJanne Heß1-0/+4
2023-10-20Merge branch 'master' into staging-nextArtturin1-1/+1
2023-10-20Merge pull request #253764 from linj-fork/fix-ping-wrapperMartin Weinelt1-1/+1
nixos/network-interfaces: stop wrapping ping with cap_net_raw
2023-10-19Merge master into staging-nextgithub-actions[bot]1-1/+1
2023-10-19nixos/doc/manual/development/writing-documentation.xml: fix build command ↵Michael Schneider1-1/+1
(#262044)
2023-10-12Merge remote-tracking branch 'origin/master' into staging-nextAlyssa Ross1-5/+3
Conflicts: pkgs/development/python-modules/bambi/default.nix pkgs/development/python-modules/jaxopt/default.nix
2023-10-12Merge pull request #259927 from asymmetric/no-docbook-in-manualSilvan Mosberger1-5/+3
nixos/manual: no DocBook for mkPackageOption
2023-10-10Merge master into staging-nextgithub-actions[bot]1-1/+1
2023-10-09nixos/doc/mkOptionType: small typo fixDoron Behar1-1/+1
2023-10-09nixos/manual: no DocBook for mkPackageOptionLorenzo Manacorda1-5/+3
`mkPackageOptionMD` is now an alias of `mkPackageOption`, and the transition from DocBook to CommonMark has been completed.
2023-09-27manual: fix parsing differences for markdown-it-py 3pennae1-1/+1
version 3 now recognizes these replacements as escaped, but neither look like they should be.
2023-09-22nixos/switch-to-configuration: Never unmount / or /nixJanne Heß1-2/+3
Also adds a huge test for fstab handling
2023-09-21nixos/network-interfaces: stop wrapping ping with cap_net_rawLin Jian1-1/+1
From systemd 243 release note[1]: This release enables unprivileged programs (i.e. requiring neither setuid nor file capabilities) to send ICMP Echo (i.e. ping) requests by turning on the "net.ipv4.ping_group_range" sysctl of the Linux kernel for the whole UNIX group range, i.e. all processes. So this wrapper is not needed any more. See also [2] and [3]. This patch also removes: - apparmor profiles in NixOS for ping itself and the wrapped one - other references for the wrapped ping [1]: https://github.com/systemd/systemd/blob/8e2d9d40b33bc8e8f5d3479fb075d3fab32a4184/NEWS#L6457-L6464 [2]: https://github.com/systemd/systemd/pull/13141 [3]: https://fedoraproject.org/wiki/Changes/EnableSysctlPingGroupRange
2023-08-21nixos/stc: Improve mount unit handlingJanne Heß1-2/+5
We should sometimes restart the units rather than reloading them so the changes are actually applied. / and /nix are explicitly excluded because there was some very old issue where these were unmounted. I don't think this will affect many people since most people use fstab mounts instead but I plan to adapt this behavior for fstab mounts as well in the future (once I wrote a test for the fstab thingies).
2023-07-10integration test driver: Auto-generate integration test driver's machineJacek Galowicz1-204/+1
method documentation of nixos docs from python doc strings
2023-06-27lib/types: add pathInStoreNaïm Favier1-0/+5
2023-05-10lib.types.pkgs: initRobert Hensing1-0/+4
A nominal type.
2023-05-05Merge pull request #228111 from alyssais/nixosTest-hostnameJacek Galowicz2-0/+7
nixosTest: remove hostname limitations