Commit Graph

31 Commits

Author SHA1 Message Date
github-actions[bot]
ff59322b65
Merge staging-next into staging 2023-11-10 00:02:49 +00:00
github-actions[bot]
3f616fad02
Merge master into staging-next 2023-11-10 00:02:22 +00: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
Anderson Torres
54f864f5c5 doc: update meson.section.md 2023-10-30 16:32:56 -03:00
Weijia Wang
0fdb1ee374 doc: fix heading of mesonInstallTags 2023-10-27 16:59:43 +02:00
Julian Stecklina
36eff4f431 meson: introduce mesonInstallTags
Projects building with meson are currently installTargets. Map these
to install tags, which are roughly equivalent. This allows projects to
selectively install components.
2023-10-23 01:46:24 +02:00
Alyssa Ross
31ebe7b459 doc: fix heading levels of Meson hook documentation
Fixes: 10f35ff05d ("meson.setupHook: prefer meson commands over ninja")
2023-10-21 15:26:27 +00:00
Alyssa Ross
10f35ff05d meson.setupHook: prefer meson commands over ninja
Meson now comes with its own set of commands for building, testing,
installing etc., that by default wrap around Ninja.  The reason to
prefer using the Meson commands is that they take additional
options (e.g. setting custom timeouts for tests — my motivation for
this change).

Here, I've modified the Meson setup hook so that Meson's test and
install commands will be used instead of Ninja's when Meson's
configurePhase is used.  This restriction is to avoid starting to run
Meson directly when dealing with custom build systems that wrap around
Meson, like QEMU's.  We don't use meson's compile command, as it just
runs ninja, and that's handled fine by the existing Ninja setup hook.

Naturally the Meson commands don't support entirely the same set of
options that the Ninja ones did, but I checked through Nixpkgs to find
any packages using Meson that used any options that wouldn't be picked
up by this new system.  I only found one, and it was just setting
checkTarget = "test", which is the default value for Ninja and has no
Meson equivalent (because we directly tell Meson to run the tests
rather than going through a generic job system like Ninja).

Link: https://github.com/NixOS/nixpkgs/issues/113829
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-09 10:21:36 +00:00
Peder Bergebakken Sundt
470614b671 treewide: Fix typos 2023-09-28 19:06:13 +02:00
Anderson Torres
c1b3bfba4f doc: include short docs about bmake 2023-09-22 01:38:23 -03:00
Anderson Torres
eea12fdf8c doc/hooks/zig.section.md: rewrite
- Normalize header IDs, in order to not cause conflicts with identically named
  headers in other docs.
- Reorganize the hierarchy of information.
2023-09-10 16:23:27 -03:00
Anderson Torres
a0b25e2566 doc/hooks/waf.section.md: rewrite
- Normalize header IDs, in order to not cause conflicts with identically named
  headers in other docs.
- Reorganize the hierarchy of information.
2023-09-10 16:23:22 -03:00
Anderson Torres
1b75ac310a doc/hooks/zig.section.md: reword
- Refer to stdenv documentation instead of repeating it
2023-09-09 15:27:11 +00:00
Anderson Torres
8e93a78ef4 doc/hooks/waf.section.md: change wafHook to waf.hook 2023-08-26 13:12:09 +00:00
github-actions[bot]
4cdbb53d13
Merge master into staging-next 2023-08-26 12:01:05 +00:00
Mario Rodas
e095804702 wafHook: fix missing header id 2023-08-24 04:20:00 +00:00
Markus Kowalewski
587a19e43c mpiCheckPhaseHook: add new setup hook for MPI aware check phases
Add this hook to checkPhase to allow for running MPI application in
the sandbox. It detects the MPI implementations and sets the respective
environment variables.
2023-08-22 23:27:47 +02:00
Anderson Torres
b5549d90f2 wafHook: documentation
A very comprehensive one!
2023-08-13 03:23:09 +00:00
figsoda
59eb02116f treewide: use zig_0_11 instead of zig for zig packages
Zig is still under active development, and new releases often introduce
breaking changes. This makes updating the default version of zig easier.

Some packages did not receive this change because they could be using
the c compiler or linker of zig, which doesn't receive as much breaking
changes compared to e.g. the zig std library.

https://github.com/NixOS/nixpkgs/pull/248243#discussion_r1289401340
2023-08-10 02:37:53 +00:00
figsoda
17d404ee80 zig.hook: rename from zigHook
This makes using specific versions of zig easier (without overrides)
2023-08-10 02:37:53 +00:00
Anderson Torres
130d2fa5e5 doc/hooks/index.md: add zig.section.md
A somewhat short documentation about zigHook.
2023-08-01 10:08:55 +00:00
pennae
be4d19ff1a doc: render nixpkgs manual with nrd
also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit
because that would leave the manual build broken for one commit,
potentially breaking bisects and rebases.
2023-07-01 20:59:29 +02:00
pennae
e42a5c78e7 doc: make sure section depths are consecutive
skipping heading levels (eg from # to ###, or starting at ###) is legal
in pandoc, but not in nixos-render-docs. pandoc acts as though section
levels *were* consecutive, nixos-render-docs prefers to tell people not
to do that kind of thing because it can make documents more fragile.
2023-06-10 18:17:04 +02:00
pennae
a15d7335a5 nixos/manual: remove .title fenced divs
pandoc drops .title classes when rendering to docbook, so these are
effectively just paragraphs anyway. without support for including them
in a table of contents the complexity of parsing them in
nixos-render-docs won't be warranted.
2023-02-10 06:40:00 +01:00
Nick Cao
0ea2d480e4
postgresqlTestHook: run postgresqlTestSetupPost hook after setting up 2023-01-25 18:46:27 +08:00
Guillaume Girol
d26caea94b doc: adapt to nativeCheckInputs 2023-01-21 16:42:10 +01:00
Shamrock Lee
da31bd5673 patchRcPathBash, patchRcPathCsh, patchRcPathFish, patchRcPathPosix: init
Init patchRcPath hooks, which provides
utilities to patch shell scripts to be sourced by users.

Add test cases and documentation.
2022-11-10 09:23:52 +08:00
Robert Hensing
2db8de920e doc: Move non-stdenv hooks out of stdenv chapter 2022-10-13 15:40:27 +02:00
Robert Hensing
b2def3c2ce doc/postgresql-test-hook: Add example 2022-09-19 18:14:31 +01:00
Robert Hensing
99fed858bb doc/hooks/index.xml: Fix typo and terminology 2022-04-18 11:57:35 +02:00
Robert Hensing
e77e09c5d2 postgresqlTestHook: init 2022-04-16 17:17:46 +02:00