1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-17 19:21:04 +00:00
Commit graph

346 commits

Author SHA1 Message Date
Artturin 7a199f5dd6
nixos/doc: add documentation for formats.hocon and formats.libconfig (#320339) 2024-09-10 18:26:10 +03:00
Peder Bergebakken Sundt 99dec1f6b0 treewide: fix doc typos
Done with `fd \\\.md$ . --type f -x typos --write-changes`
2024-07-26 00:55:13 +02:00
h7x4 bf2adb82b7
nixos/doc: move implementation notes for formats.libconfig to docs 2024-06-16 20:58:50 +02:00
h7x4 a891526b22
nixos/doc: add documentation for formats.libconfig 2024-06-16 20:58:49 +02:00
h7x4 141a8a6c86
nixos/doc: move implementation notes for formats.hocon to docs 2024-06-16 20:58:48 +02:00
h7x4 89aaab565e
nixos/doc: add documentation for formats.hocon 2024-06-16 20:58:47 +02:00
Pedro O. A. Regis 015e29a742 doc: removes extra backtick 2024-06-07 15:21:57 -03:00
Sizhe Zhao 5209c84957
nixos/activation/bootspec: fix style 2024-06-05 11:14:36 +08:00
Sizhe Zhao 4f05b8e213
nixos/activation/bootspec: rephrase 2024-06-05 11:13:43 +08:00
Sizhe Zhao 3a4753867d
nixos/activation/bootspec: no longer experimental 2024-06-05 11:09:55 +08:00
Sizhe Zhao 0aaccaa596
nixos/activation/bootspec: now enabled by default 2024-06-05 11:06:03 +08:00
crayor1 970f689a49
nixos/doc: fix a typo in option-declarations.section.md (#304733)
Fix a typo
2024-05-18 13:06:50 +08:00
nhnn 083f211783
pkgs: add PHP to formats.nix 2024-05-16 13:07:34 +03:00
Silvan Mosberger 4f1d724b82
Merge pull request #284551 from hercules-ci/types-attrTag
Add `types.attrTag`
2024-04-09 20:48:44 +02:00
Robert Hensing f354686536 doc/option-types: Update sum types 2024-04-04 12:00:54 +02:00
Robert Hensing fa8b46adf4 doc/option-types: Make attrTag example self-contained
... well, except for the ellipses, which hide unnecessary descriptions,
which you should write!
2024-04-04 11:54:46 +02:00
Robert Hensing c0f54d3dea doc/option-types: Add attrTag example 2024-04-04 11:54:46 +02:00
Philip Taron ebde306504
nixos/lib, doc: remove references to mdDoc (#300738)
* 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-04-01 16:58:23 -07:00
Janne Heß fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Anton Dyudin 811ec16c8a
doc: Fix test in writing-nixos-tests.section.md (#294902)
* 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-12 19:19:54 -07:00
Philip Taron 86ae7a6243
Remove top level with lib; in docs (#293829) 2024-03-06 22:35:43 +01:00
Robert Hensing eb787006d7 nixos/doc/running-nixos-tests: Describe system requirements 2024-03-05 20:51:10 +01:00
benaryorg 8b2d86b982
pkgs.formats: toINIWithGlobalSection wrapper
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-12 17:58:48 +00:00
Robert Hensing 6949bc21ce doc/option-types: Move nullOr to Union types 2024-02-11 18:45:16 +01:00
Robert Hensing 1ad30772ea doc/option-types: Move attrTag to Sum types, remove redundant paragraph 2024-02-11 18:45:15 +01:00
Robert Hensing 2ceb5558f9 doc/option-types: Move either and oneOf to Union types 2024-02-11 18:45:15 +01:00
Robert Hensing 0feea2dbd2 doc/option-types: Write about sum and union types 2024-02-11 18:45:15 +01:00
Robert Hensing ca81a89839 lib.types.attrTag: init 2024-02-11 18:44:52 +01:00
Silvan Mosberger f37ba19765
Merge pull request #284512 from hercules-ci/lib-types-unique-merge
lib.types.unique: Check inner type deeply
2024-02-10 02:52:45 +01:00
Robert Hensing 2b4a1a1d4f doc/option-types: Definitions are not declared 2024-01-29 19:13:37 +01:00
Alejandro Sanchez Medina a63b9c15c9 doc: Update manuals bespoke syntax
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-25 16:33:35 +01:00
nikstur dbd8cb9d46 nixos/etc: add manual section 2024-01-22 00:54:13 +01:00
nikstur d10ef8be71 switch-to-configuration: add sysinit-reactivation manual section 2024-01-18 00:46:30 +01:00
nikstur e6b66f08a5 nixos/switch-to-configuration: add sysinit-reactivation.target 2024-01-18 00:46:30 +01:00
Silvan Mosberger 8d3978c149 lib.types.boolByOr: init
This type is necessary to have correct merging behavior for
`allowUnfreePredicate` and `allowInsecurePredicate`

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-08 21:50:29 +01:00
K900 9ad22d35b6
Revert "nixos/switch-to-configuration: remove explicit tmpfiles invocation" 2023-11-29 09:38:27 +03:00
nikstur fa41730b86 nixos/switch-to-configuration: remove explicit tmpfiles invocation 2023-11-25 21:39:10 +01:00
K900 e792d7fec0
Merge pull request #264442 from anthonyroussel/update-url-redirects
treewide: fix redirected and broken URLs
2023-11-11 18:08:59 +03:00
Niklas Hambüchen f9611764c6 manual: Fix QEMU_NET_OPTS VM-side address.
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-11 15:40:55 +01:00
Anthony Roussel e30f48be94
treewide: fix redirected and broken URLs
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-11 10:49:01 +01:00
Niklas Hambüchen dcceeb9868 manual: tests: Describe how to port-forward into test VMs 2023-11-10 22:29:12 +01:00
Arnout Engelen 97b0ae26f7
doc: avoid 'simply' (#266434)
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-11-09 21:48:05 +01:00
Robert Hensing 8b385c91c3
Merge pull request #263462 from nikstur/rebuildable-system
Rebuildable system & appliance
2023-10-29 08:02:35 +01:00
nikstur 996cf6ac56 nixos/docs: add non-switchable-systems section 2023-10-28 13:26:33 +02:00
github-actions[bot] cfc75eec46
Merge master into staging-next 2023-10-20 18:00:54 +00:00
Janne Heß a1012b2160
nixos/switch-to-configuration: Allow not filtering units 2023-10-20 15:45:43 +02:00
Artturin 3342d1a9a9 Merge branch 'master' into staging-next 2023-10-20 09:29:36 +03:00
Martin Weinelt d042a29613
Merge pull request #253764 from linj-fork/fix-ping-wrapper
nixos/network-interfaces: stop wrapping ping with cap_net_raw
2023-10-20 00:57:55 +02:00
github-actions[bot] 25bcfa6c2f
Merge master into staging-next 2023-10-19 12:01:00 +00:00
Michael Schneider c22fed2281
nixos/doc/manual/development/writing-documentation.xml: fix build command (#262044) 2023-10-19 13:43:03 +02:00