Commit Graph

27 Commits

Author SHA1 Message Date
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
Frederik Rietdijk
acfc517a80 nixpkgs manual: move builders into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk
efb55d2a42 doc: split packages part into xml file per package 2019-10-20 13:35:04 +02:00