Commit Graph

52 Commits

Author SHA1 Message Date
Aryeh Hillman
84a11ebe42 Update instructions for Nix remote builder connection
Clarify instructions for connecting to the default remote builder and add information on SSH access.
2025-10-30 15:54:32 -07:00
Maximilian Bosch
1965f3c77d linux: manual-config.nix -> build.nix
Since I started touching this subsystem, I found the name confusing
since this is the part where we actually compile the kernel and we have
a ready-to-use configuration.

The stated goal of the commit introducing it[1] is to provide a function
to

> make it possible to build a kernel with a user provided .config.

Considering that this is supposed to be a differentiation from other
build mechanisms and nowadays this is the only way to build kernels in
nixpkgs, I figured that `build.nix` is a better name.

`pkgs.linuxManualConfig` isn't renamed on purpose: Kloenk and I are
planning to do more involved work and it may become necessary to change
parts of the API. So asking users to do a migration now just to add
another one soon isn't worth it.

[1] bf7467cbb1
2025-10-24 18:06:29 +02:00
h7x4
ee52b9f087 nrfutil: 7.13.0 -> 8.1.1, package all installables
This commit introduces a `withExtensions` function, to allow for
downloading and using the other installable parts of nrfutil.

It also introduces support for aarch64-linux, as well as updating the
program.
2025-10-16 23:29:21 +09:00
Maximilian Bosch
9f95c2ace2 linux: new workflow for kernel changes
See https://github.com/NixOS/nixpkgs/issues/437208#issuecomment-3288623669
Depends on https://github.com/NixOS/org/pull/172

As documented below, the idea is to essentially group all changes
rebuilding all VM tests with kernel updates and merge them together into
`master` whenever the Linux kernels get updated.

This documents the workflow of updates in the nixpkgs manual. While at
it, I removed the README from the packages because

* it's horribly outdated
* I didn't even know it exists which confirms that its discoverability
  was very poor

and added the relevant portions into the nixpkgs manual as well.
2025-10-05 22:59:25 +02:00
Benjamin Sparks
3ffa8c3346 uv: add manual entry 2025-09-11 19:23:09 +02:00
Ben Siraphob
cc5b731ed3 doc: fix typos 2025-08-27 11:46:26 -07:00
Maximilian Bosch
dccb264578 linux: remove mentions of extraStructuredConfig & throw error
PR #431115 changed extraStructuredConfig to structuredExtraConfig to
follow the deprecation warning about `extraConfig`. However,
`extraStructuredConfig` was mentioned in several places in the docs that
weren't addressed. Also, using this would silently fail since the code
in question would still accept the old key.

This patch updates the docs accordingly and throws an error if the
code-path is reached and `extraStructuredConfig` is being used.
2025-08-10 14:10:50 +02:00
Wolfgang Walther
62fe016519 treewide: run treefmt with mdcr/nixfmt 2025-07-24 13:52:31 +02:00
Yifei Sun
dbbf70e0a8 doc/packages/python-tree-sitter: fix typo 2025-06-29 13:43:25 +02:00
Niklas Hambüchen
ee6c2bd2eb doc: Fix missing pre/post hooks everywhere 2025-05-24 13:22:41 +00:00
Matt Sturgeon
4c638c2735 doc/packages/treefmt: add option reference docs
Add a `treefmt.optionsDoc` passthru, which is included on the treefmt
section of the nixpkgs manual.

This generates reference docs for options declared in
`treefmt.evalConfig`.
2025-05-20 07:52:11 +02:00
Matt Sturgeon
301824d216 doc/packages/treefmt: add function reference docs
Add a `treefmt.functionsDoc` passthru, which is included on the treefmt
section of the nixpkgs manual.

This generates reference docs for functions defined in
`pkgs/by-name/tr/treefmt/lib.nix`, using `nixdoc`.
2025-05-20 07:52:11 +02:00
Matt Sturgeon
fe586a5d59 doc/packages: add treefmt section 2025-05-20 07:52:11 +02:00
Wolfgang Walther
d3842f26e8 doc/build-support: replace substituteAll with replaceVars 2025-04-23 23:27:22 +02:00
Pol Dellaiera
30eb01e120 doc: remove useless rec 2025-04-21 07:02:49 +02:00
Pol Dellaiera
bcea0cf344 doc: update Nix code snippets format
Command: `mdcr --config doc/tests/mdcr-config.toml doc/`
2025-04-17 01:30:34 +02:00
Adrien Faure
a9cf0041df doc/packages/python-tree-sitter: add documentation 2025-04-02 08:31:10 +01:00
tropf
f2e0c05a46 doc: add section on inkscape plugins 2025-03-19 18:05:42 +01:00
K900
5da892d21c mesa: output cleanup, part 2
- build with out-of-tree libgbm
- $drivers -> $out, since $out is basically empty now
2025-03-11 22:16:23 +03:00
Adam Dinwoodie
a46eb8266a doc/packages/build-support: remove stray backtick
This corrects a start/end error in the formatting of code in one of the
examples.
2024-12-31 19:29:43 +00:00
Wolfgang Walther
1dd9c32b18 docs: remove references before 22.11
Stuff that has been in for many years doesn't need to be mentioned
explicitly anymore.
2024-11-17 12:51:09 +01:00
Robert Hensing
1d76033154 Rename nixos/modules/profiles/{macos-builder.nix -> nix-builder-vm.nix} 2024-10-08 10:27:11 +02:00
nicoo
19cf0942e3 doc: update all fetchurl invocations with a hash in SRI format 2024-09-17 10:47:31 +02:00
Tomodachi94
1e71925b95 doc/packages/lhapdf: add documentation
This documents:
* The existence of the `lhapdf` package (not particularly important)
* The existence of the `lhapdf.pdf_sets` attrset (important)
* The setup hook used in all of the entries in `lhapdf.pdf_sets`
  (slightly important)

Part of #341479.
2024-09-13 23:18:10 -07:00
Tomodachi94
cfe30e5950 doc/packages/geant4: add documentation
This documents:
* The `geant4.data` attrset introduced in #39514
* The setup hook for geant4
* The setup hook for the geant4.data packages

I also added a brief description of what Geant4 is.

Part of #341479
2024-09-13 21:01:35 -07:00
Nathan Henrie
f5f24cdb58 doc: add documentation for pkgs.{substitute,substituteAll,substituteAllFiles}
Fixes https://github.com/NixOS/nixpkgs/issues/65252
2024-08-21 20:11:02 +02:00
h7x4
cce9bb28dc doc/packages/vcpkg: init 2024-07-17 09:26:15 +02:00
GY
bcc7eff2c5 nixos/input-method: deprecate .enabled option; add .type and .enable options
This commit introduces two new properties:
`enable` and `type`, to replace the `enabled` property.
`enable` has the same meaning as is common across nixpkgs.
`type` has the same meaning as the existing `enabled` property.
`enabled` property is now deprecated and will be removed in a future release.

Fixes #180654
2024-07-12 03:59:20 -04:00
Jdogzz
bca30eb509 doc: remove outdated Steam documentation related to Java
Fixes #297694.
2024-06-25 19:27:58 -07:00
Pankaj Raghav
7ce0c7abf8 doc: use linuxPackages_custom instead of linuxManualConfig (#319046)
linuxManualConfig involves more boilerplate to change the kernel. Use
the wrapper linuxPackages_custom which is wrapper that takes an
attribute sets and calls linuxManualConfig approrpriately.

This is much easier for beginners to use instead of linuxManualConfig
helper.

Point to linuxManualConfig for further customizations.
2024-06-11 23:21:58 +02:00
Sandro Jäckel
104f24e0b9 Revert "doc: replace fzf-share mention with sk-share from Skim package"
This reverts commit de5b2ef096.
2024-04-11 15:08:51 +02:00
Mario Rodas
5d58ded833 Merge pull request #298692 from SebTM/auto-update/fzf
fzf: 0.47.0 -> 0.48.1
2024-04-07 14:42:45 -05:00
Peder Bergebakken Sundt
0e4bf5608f Merge pull request #285177 from lelgenio/krita-plugin-gmic-package
krita: wrap with plugins, krita-plugin-gmic init at 3.2.4.1
2024-04-07 21:42:25 +02:00
lelgenio
1816172445 doc: add krita plugins section 2024-04-07 02:12:36 -03:00
Mario Rodas
de5b2ef096 doc: replace fzf-share mention with sk-share from Skim package
`fzf-share` was removed
2024-04-07 04:20:00 +00: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
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00
Daniel Sidhion
3ef3dbe6d5 Merge pull request #291715 from DanielSidhion/document-private-key
doc: document publicly-known private key for darwin.linux-builder
2024-02-28 06:37:18 -08:00
yihuang
267735f785 doc: fix darwin-builder doc (#291518) 2024-02-28 06:36:13 -08:00
DS
fced134442 doc: document publicly-known private key for darwin.linux-builder 2024-02-26 17:37:53 -08:00
Thane Gill
9d22da290a Fix syntax error in darwin-builder.section.md 2024-02-13 14:07:27 -08:00
Julian Stecklina
1b7e43471f doc: remove misleading kernel.features explanation
At this point kernel.features is more of an implementation detail and
normal users should not come into contact with it.
2024-01-22 13:19:32 +01:00
Dee Anzorge
f124c73686 nginx: change etags for statically compressed files served from store
Per RFC 9110, [section 8.8.1][1], different representations of the same
resource should have different Etags:

> A strong validator is unique across all versions of all
> representations associated with a particular resource over time.
> However, there is no implication of uniqueness across representations
> of different resources (i.e., the same strong validator might be in
> use for representations of multiple resources at the same time and
> does not imply that those representations are equivalent)

When serving statically compressed files (ie, when there is an existing
corresponding .gz/.br/etc. file on disk), Nginx sends the Etag marked
as strong. These tags should be different for each compressed format
(as shown in  an explicit example in section [8.8.3.3][2] of the RFC).
Upstream Etags are composed of the file modification timestamp and
content length, and the latter generally changes between these
representations.

Previous implementation of Nix-specific Etags for things served from
store used the store hash. This is fine to share between different
files, but it becomes a problem for statically compressed versions of
the same file, as it means Nginx was serving different representations
of the same resource with the same Etag, marked as strong.

This patch addresses this by imitating the upstream Nginx behavior, and
appending the value of content length to the store hash.

[1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-validator-fields
[2]:
https://www.rfc-editor.org/rfc/rfc9110.html#name-example-entity-tags-varying
2024-01-13 22:07:50 +01:00
Gabriella Gonzalez
4cb41faba7 darwin.linuxBuilder: Fix working directory in documentation
This fixes the working directory for the suggested flake, as originally
suggested by @MaxDaten in:

https://github.com/NixOS/nixpkgs/issues/229542#issuecomment-1674886874

… and then amended by @Enzime in:

https://github.com/NixOS/nixpkgs/pull/248554#issuecomment-1676825733
2023-11-25 20:35:45 -08:00
DS
1d7ee9ff09 doc: consolidate info on manual linux kernel configs
The Nixpkgs documentation on the linux kernel builders focused on
using and extending kernels that were already packaged, but never
mentioned that it's possible to also build a kernel almost "from
scratch".
The NixOS documentation went a bit deeper on manual linux kernel
configs, but that information wasn't particularly NixOS-specific.

This commit consolidates the information related to building the
kernel on Nixpkgs's documentation, while keeping any additional
NixOS-specific information on NixOS's documentation.

An additional README.md was created for contributor-facing
documentation.
2023-11-23 08:50:16 -08: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
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
Yueh-Shun Li
70f21a2136 doc: darwin.linux-builder: replace "builder" with "remote builder" 2023-11-07 19:58:52 +00:00
Yueh-Shun Li
e58b71da99 doc: move section darwin-builder under chapter packages 2023-11-07 19:58:51 +00:00
Yueh-Shun Li
a12beafc57 doc: move doc/builders/packages -> doc/packages 2023-11-07 19:58:51 +00:00