Commit graph

2673 commits

Author SHA1 Message Date
Alejandro Sanchez Medina 13e4891d6d nixpkgs manual: doc python: render manual notes as admonitions 2023-08-21 16:02:34 +02:00
Theodore Ni ece0953571
Merge branch 'staging-next' into staging 2023-08-18 16:02:27 -07:00
Alejandro Sánchez Medina 8cd56a3b7a
Documentation: nixpkgs manual: move Python reference to the top of Python chapter (#247117)
* nixpkgs manual, doc Python: move Reference/Optimizations to FAQ

See https://github.com/NixOS/nixpkgs/issues/246234.

* nixpkgs manual, doc Python: move Reference/python-optional-dependencies to FAQ

See https://github.com/NixOS/nixpkgs/issues/246234.

* nixpkgs manual, doc Python: move Reference/Tools to FAQ

See https://github.com/NixOS/nixpkgs/issues/246234.

* nixpkgs manual, doc Python: move Reference/deterministic-builds to FAQ

See https://github.com/NixOS/nixpkgs/issues/246234.

* nixpkgs manual, doc Python: move Reference/automatic-tests to FAQ

See https://github.com/NixOS/nixpkgs/issues/246234.

* nixpkgs manual, doc Python: move Reference to top section

See https://github.com/NixOS/nixpkgs/issues/246234.
2023-08-17 14:45:29 +02:00
mdarocha a36883ddfe maintainers: add dotnet team 2023-08-16 08:49:08 +02:00
linsui da614d98e9 lib/gvariant: init 2023-08-15 19:20:39 +08:00
Nick Hu ae8aba3836
doc/stdenv/stdenv.chapter.md: add information about nix-update-script and nixpkgs-update 2023-08-15 10:13:39 +01:00
github-actions[bot] 0ce93b670f
Merge staging-next into staging 2023-08-15 00:02:28 +00:00
Silvan Mosberger 50d11650a7
Merge pull request #245243 from tweag/contributing-combining
Clean up contributing documentation
2023-08-14 21:06:06 +02:00
github-actions[bot] af2c148bc3
Merge staging-next into staging 2023-08-14 18:01:33 +00:00
Artturin b93da3f4b7 treewide: overrideScope' -> overrideScope
`lib.makeScope` `overrideScope'` has been renamed to `overrideScope`

`fd --type f | xargs sd --string-mode "overrideScope'" "overrideScope"`
2023-08-14 18:46:47 +03:00
Silvan Mosberger 553daaed73 doc/README.md: Cleanup 2023-08-14 04:46:16 +02:00
Silvan Mosberger 37968083e7 CONTRIBUTING.md: Move opening issues section to Nixpkgs manual
This isn't relevant to contributors specifically, it applies to all
users
2023-08-13 22:04:57 +02:00
Silvan Mosberger 549ecbc977 doc: Add empty development section 2023-08-13 22:04:56 +02:00
Silvan Mosberger 129da60f57 doc/vulnerability-roundup: Rough move to new contribution doc files
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.

Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:04:56 +02:00
Silvan Mosberger 86f14e461e doc/submitting-changes: Rough move to new contribution doc files
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.

Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:04:56 +02:00
Silvan Mosberger f3a050a191 doc/reviewing-contributions: Rough move to new contribution doc files
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.

Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:04:56 +02:00
Silvan Mosberger 90bf25d037 doc/quick-start: Rough move to new contribution doc files
Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:04:56 +02:00
Silvan Mosberger 74b17a515f doc/contributing-to-documentation: Rough move to new contribution doc files
Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:04:55 +02:00
Silvan Mosberger 1e1cd398d4 doc/coding-conventions: Rough move to new contribution doc files
No content was changed, new titles are wrapped with () to signal that
they will need to be decided on in a future commit.

Section in the manual have been preserved with a simple redirect to
GitHub, the proper anchors should be filled out in a future commit once
the new section names are decided.
2023-08-13 22:02:34 +02:00
Silvan Mosberger d70091c3ad Create unified markdown files for contributing docs 2023-08-13 21:54:50 +02:00
Silvan Mosberger be26d79f46 doc/contributing: Remove unreferenced legacy diagram
Not used anymore after b3fa79bb89
2023-08-13 21:54:50 +02:00
Anderson Torres b5549d90f2 wafHook: documentation
A very comprehensive one!
2023-08-13 03:23:09 +00:00
Silvan Mosberger bfe04ea76c
Merge pull request #241656 from mobusoperandi/update-doc-contributing
fix outdated contributing to documentation
2023-08-10 17:15:05 +02:00
Silvan Mosberger 731c21db95
Update doc/contributing/contributing-to-documentation.chapter.md
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-08-10 16:12:07 +02:00
Silvan Mosberger 37ba768fb4
Merge pull request #241871 from mobusoperandi/doc-doc-syntax-chapter
doc syntax section into chapter, link from nixos manual
2023-08-10 16:11:25 +02: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
sternenseemann af60e68744 testers.hasPkgConfigModules: allow checking multiple pkg-config mods
This is very useful in conjunction with meta.pkgConfigModules, as the
new tester can use the list provided by this meta attribute as a default
value for moduleNames, making its usage in passthru.tests very
convenient.

For backwards compatibility, a shim under the old name is maintained
with a warning.
2023-08-08 19:16:48 +02:00
github-actions[bot] 4507a6bd1f
Merge master into staging-next 2023-08-08 00:01:49 +00:00
Alejandro Sánchez Medina c72480119a
nixpkgs manual, doc Python: render interpreters in a table (#246956)
* nixpkgs manual, doc Python: render interpreters in a table

The current paragraph presenting Python interpreters is verbose and hinders clarity. The information provided is well suited to be rendered as a table.

Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>

* nixpkgs manual, doc Python: fix typos in interpreters' table

* nixpkgs manual, doc Python: update header in interpreters' table

* nixpkgs manual, doc Python: get rid of empty block code workaround in interpreters' table

---------

Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-08-07 23:48:22 +02:00
Vladimír Čunát 3a5c176f95
Merge branch 'master' into staging-next 2023-08-05 07:40:22 +02:00
Dmitry Kalinkin aa725d5a5b
Merge pull request #225503 from xworld21/texlive-binaries-from-tlpdb
texlive: generate bin containers from tlpdb
2023-08-04 22:31:30 -04:00
github-actions[bot] 16547be5c0
Merge master into staging-next 2023-08-05 00:02:07 +00:00
Artturin 61c0ecea5b treewide: update mainProgram docs 2023-08-04 20:31:16 +03:00
github-actions[bot] 0542af4e29
Merge master into staging-next 2023-08-04 00:02:04 +00:00
Jan Malakhovski ccbb065c88 doc: make sourceRoot and setSourceRoot documentation match the implementation, fix examples 2023-08-03 16:32:05 +00:00
Alejandro Sanchez Medina b751910048 fix outdated contributing to documentation
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-08-03 13:21:48 +02:00
Vladimír Čunát 55f778d2b5
Merge branch 'master' into staging-next 2023-08-01 18:22:43 +02:00
Weijia Wang 1da4ff5585
Merge pull request #240553 from tomodachi94/doc/prefer-maven.buildPackage
doc/maven: prefer maven.buildMavenPackage over mvn2nix
2023-08-01 17:36:03 +02:00
Weijia Wang 3bf9e65881 doc/maven: add stable-maven-plugins back 2023-08-01 16:00:52 +02:00
Doron Behar cc63e791bf Merge branch 'master' into staging-next
* master: (77 commits)
  containerd: 1.7.2 -> 1.7.3
  python310Packages.transformers: 4.30.2 -> 4.31.0
  plasma-sdk: unbreak build, again
  stellarium: add patch for indi 2.0 compatibility
  indi-full: 1.9.8 -> 2.0.2, reenable Atik, Pentax and SX drivers
  indilib: 1.9.8 -> 2.0.2
  plasma: 5.27.6 -> 5.27.7
  alsa-scarlett-gui: light refactoring
  alsa-scarlett-gui: Change icons path back to relative in desktop entry file
  alsa-scarlet-gui: light refactoring Done some light refactoring for better consitence in the code.
  alsa-scarlett-gui: fix for deskop integration
  alsa-scarlett-gui: fixed desktop entry
  release-notes: note breaking woodpecker update
  woodpecker-*: 0.15.11 -> 1.0.0
  pnpm-lock-export: use fork with v6 support
  suricata: 6.0.13 -> 7.0.0
  rubyfmt: add support for macos arm64/x86
  rubyfmt: init at 0.8.1
  dayon: init at 11.0.7
  nixos/atuin: harden systemd unit
  ...
2023-08-01 16:52:24 +03: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
Tomo 48bbc6d964 doc/maven: prefer maven.buildMavenPackage over mvn2nix
Manually calling `mvn2nix` was the preferred way of building
Java apps that use Maven, but `maven.buildMavenPackage` is now the
preferred way.
2023-08-01 10:19:26 +02:00
Martin Weinelt 167f6dfee4
Merge remote-tracking branch 'origin/master' into staging-next
Conflicts:
- pkgs/development/libraries/science/astronomy/cfitsio/default.nix
2023-07-30 03:54:27 +02:00
pennae dcd55915ad
Merge pull request #245358 from asymmetric/nixpkgs-doc-build-instructions
doc/contributing: update build instructions after nrd
2023-07-29 23:22:43 +02:00
Vincenzo Mantova 01af940407 texlive.combine: include packages with man pages by default 2023-07-29 18:31:17 +02:00
Doron Behar 6560d0086c python3.pkgs.pypaBuildHook: init 2023-07-28 12:13:25 +02:00
Doron Behar 1298c367b1 pip-build-hook.sh: Support $pipBuildFlags 2023-07-28 12:13:25 +02:00
Doron Behar 5262a7d1c9 doc/python: Demonstrate how to override the blas implementation 2023-07-28 12:13:25 +02:00
Silvan Mosberger a7e5800273
Merge pull request #243062 from mobusoperandi/doc_watchexec
nixpkgs/NixOS manuals: devmode feature
2023-07-27 16:11:18 +02:00
Galen Huntington b0dc3d26f2
doc/stdenv: Minor syntax fix. 2023-07-26 12:15:32 -07:00
Connor Baker 495875182e
Merge pull request #224068 from SomeoneSerge/respect-config-cudaSupport
Respect global config.cudaSupport
2023-07-25 14:18:14 -04:00
Lorenzo Manacorda 35471bd134 doc/contributing: update build instructions
We have moved away from Make since nixos-render-docs was introduced to
build the nixpkgs manual in #239636.
2023-07-25 15:26:18 +02:00
Shahar "Dawn" Or a064709342 nixpkgs/NixOS manuals: devmode feature
Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-07-25 17:03:15 +07:00
Alejandro Sanchez Medina 13aeddb926 nixpkgs manual: extract some build paths
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-07-25 17:00:51 +07:00
asymmetric 46df012d2a
Merge pull request #244332 from SuperSandro2000/fonts-fonts
nixos/fonts: rename fonts.fonts option to fonts.packages, other cleanups
2023-07-25 09:49:25 +02:00
Martin Weinelt f00b8343d2
Merge pull request #243848 from SuperSandro2000/clarify-python-tools
docs/python: clarify allowance of using toosl to autogenerate packages
2023-07-24 20:16:07 +02:00
Sandro Jäckel b0c67b4b6e
treewide: rename fonts.fonts to fonts.packages 2023-07-24 17:34:39 +02:00
Sandro Jäckel 0a47d54801
docs/python: clarify allowance of using toosl to autogenerate packages 2023-07-24 16:41:08 +02:00
github-actions[bot] 41e6556ad3
Merge master into staging-next 2023-07-22 18:01:06 +00:00
Paul Colomiets 366404a9d3 Remove tailhook from maintainers 2023-07-22 14:11:29 +03:00
Someone Serge 133993211b
config.cudaSupport: init option 2023-07-20 17:57:31 +03:00
Someone Serge a17baa5db4
doc: update #cuda to reflect the recommended config.cudaSupport style 2023-07-20 17:27:07 +03:00
github-actions[bot] 2c5b83e75c
Merge master into staging-next 2023-07-19 18:01:04 +00:00
Theodore Ni 9d55df7a37
docs/contributing: fix "ha256" -> "sha256" typo 2023-07-18 16:55:32 -07:00
github-actions[bot] 034c3854f0
Merge staging-next into staging 2023-07-16 18:01:40 +00:00
Robert Hensing 12d2f0da28
Merge pull request #240136 from NixOS/doc-review-patches
doc/reviewing-contributions: Add points about patches
2023-07-16 14:21:17 +02:00
Jan Tojnar cea188cbbb Merge branch 'staging-next' into staging
Conflicts:
 - pkgs/tools/networking/shadowfox/default.nix between e989daa65f and 1c29673fcc
 - pkgs/tools/networking/wuzz/default.nix between 7d80417710 and 1c29673fcc
2023-07-16 02:20:49 +02:00
maralorn 85331ccd98
doc/../haskell.section.md: Make a bit clearer and more beginner friendly 2023-07-15 02:18:29 +02:00
Artturin 1c29673fcc treewide: go-modules -> goModules
In 787af0f79f
I had to change ${go-modules} to $goModules to allow overrideAttrs to work;
However, env vars cannot contain -, so  i had to change go-modules too.
This in turn broke nix-update because it uses the go-modules attr.

Instead of making nix-update more complicated, make go-modules naming match cargoDeps.

`fd --type f | xargs sd '\bgo-modules\b' 'goModules'`
and revert change to pkgs/applications/misc/dstask/default.nix
and pkgs/servers/http/dave/default.nix
and pkgs/os-specific/darwin/plistwatch/default.nix

release note added
2023-07-14 00:18:06 +03:00
Alejandro Sanchez Medina ad224d61d0 nixos manual contributing link to nixpkgs syntax
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
2023-07-10 15:56:42 +07:00
Matthieu Coudron 34b3a809ef buildLuarocksPackage: rename file to match its role 2023-07-10 10:34:34 +02:00
Robert Hensing e809af74eb
Merge pull request #242312 from NixOS/doc-lib-render-fixedPoints
doc: Render lib.fixedPoints
2023-07-08 19:57:44 +02:00
Robert Hensing aa1beb0ab5 doc: Render lib.fixedPoints 2023-07-08 18:46:08 +02:00
Atemu 67eec418ab
Merge pull request #240860 from Atemu/fhsenv-no-multiarch
buildFHSEnv: disable multiArch by default
2023-07-08 13:53:41 +02:00
Mario Rodas 43b091f45c
Merge pull request #233804 from lilyinstarlight/feature/npm-workspaces
buildNpmPackage: add npmWorkspace and npmPruneFlags args
2023-07-08 06:45:46 -05:00
Michael Hoang edef486898 darwin.linux-builder: rename from darwin.builder 2023-07-06 21:33:09 +10:00
Michael Hoang 285f5e858e darwin.builder: use port 31022 by default 2023-07-06 21:32:08 +10:00
pennae 06140b7ecf
Merge pull request #239636 from pennae/nixpkgs-manual-nrd
doc: dedocbookify nixpkgs manual
2023-07-03 20:48:23 +02:00
pennae fc1b58b593 doc: inline doc-support to main drv
separating function docs out like this makes it less clear how library
documentation is generated and integrated into the build. if in the
future more parts of nixpkgs use nixdoc it will make sense to have all
information about library doc generation in the same place.
2023-07-01 20:59:30 +02:00
pennae 70cbd8c6c0 doc: pull option docs out of doc-support
this leaves doc-support as a simple wrapper around function docs. this
wrapper will go away very soon as well.
2023-07-01 20:59:30 +02:00
pennae f397309f4e doc: remove remnants of docbook times
all xml-related tooling can go away. shell.nix is no longer useful since
the makefile is gone and the build runs entirely via a derivation, and
gitignore is thus also no longer that useful. it may filter out some
swap files, but its main reason to exist (keeping generated files out of
a concurrent build of the derivation) has gone away.
2023-07-01 20:59:30 +02: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 b521f451a3 doc-support: don't expose locationsXml
nothing except function docs uses this, so we need not expose it. we'll
be reworking this entire section of the build anyway, with the target of
breaking up doc-support as it is now.
2023-07-01 20:27:29 +02:00
pennae a5414c29a0 doc: build placeholder epub in its own derivation
mostly to clean up the main manual build makefile and derivation a bit.
not technically necessary, but will make life easier later.
2023-07-01 20:27:29 +02:00
Robert Hensing 1f5a0b0135
Merge pull request #239005 from Artturin/setorfunoverr
stdenv: let overrideAttrs accept attrset OR function
2023-07-01 15:27:23 +02:00
Robert Hensing 0c9fb905cb
doc/using/overrides: Relate addition to preceding text 2023-07-01 15:25:17 +02:00
Atemu 62b2adc753 buildFHSEnv: add multiArch flag
The intention is to allow the user control over whether 32bit deps are supposed
to be included in the fhsenv
2023-07-01 13:41:14 +02:00
Artturin fb643f3260 doc/using/overrides: it is possible to use previous arguments in .override 2023-06-30 23:28:00 +03:00
Artturin 0fdae31531 stdenv: let overrideAttrs accept attrset OR function
Makes overrideAttrs usable in the same way that `override` can be used.
It allows the first argument of `overrideAttrs` to be either a function
or an attrset, instead of only a function:

hello.overrideAttrs (old: { postBuild = "echo hello"; })
hello.overrideAttrs { postBuild = "echo hello"; }

Previously only the first example was possible.

Co-authored-by: adisbladis <adisbladis@gmail.com>
Co-authored-by: matthewcroughan <matt@croughan.sh>
2023-06-30 23:28:00 +03:00
Tillerino 9def595d00
doc: add a note about automatic maven upgrades (#238774) 2023-06-30 16:59:23 +03:00
sternenseemann 8088e14e12 doc/haskell: FAQ entry on changing profiling settings globally
This is actually relatively complicated to achieve, since it involves
overriding GHC on e.g. aarch64-darwin, so the FAQ entry seems warranted.

It's also a good exercise to me, since it demonstrates some problems
with the overriding infrastructure, i.e. that it has a tendency to
inherit the pkgs fixpoint from prev. An example of this problem is
https://github.com/NixOS/nixpkgs/issues/235960, but it has different
manifestations as well. Awareness of this will also help writing the
other sections on overriding.

How complicated it is, seems to be further incentive to go ahead with
https://github.com/NixOS/nixpkgs/pull/239548 as well.
2023-06-30 01:52:42 +02:00
sternenseemann 1db464d40a doc/haskell: document {enable,disable}*Profiling functions 2023-06-30 01:52:42 +02:00
amesgen 906102c911
doc/languages-frameworks/python: don't use full pkgs in attrs 2023-06-29 21:38:37 +02:00
Lily Foster 3990bb5b5e
doc/languages-frameworks/javascript: add npmWorkspace and npmPruneFlags args 2023-06-29 07:43:12 -04:00
Adam Joseph 910d4f761a Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches""
This reverts commit 7e6c518ce4.

I misinterpreted Github's CI failure in the notification tab and
thought that I had broken CI on origin/master, so I panic-reverted
before I merged it (I thought they had).

On closer inspection, it appears that the CI failure was not from
the tip that I merged.  This PR resubmits the reverted change.  I'll
wait for OfBorg to finish this time.
2023-06-29 03:08:41 -07:00
Adam Joseph 7e6c518ce4
Revert "submitting-changes.chapter.md: explain *why* we have three branches" 2023-07-12 19:59:46 +00:00
Adam Joseph b3fa79bb89 submitting-changes.chapter.md: explain *why* we have three branches
The manual does an okay job of explaining the rules for each of the
three development branches, but really doesn't give any intuition as
to why there are three (why not four? or two?) or how we got where
we are today.

This commit attempts to fix that, by explaining that there is one
branch that allows mass-rebuild commits, and it has a fast-building
branch both upstream and downstream of it (from the perspective of
automated merges).

I have also removed the term "stabilization" from the arc labels.
This vague term is not defined anywhere, and does communicate any
useful information without a longer explanation.  Therefore it is
not appropriate for use in a diagram.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-29 02:38:06 -07:00
Lily Foster 59713b5555
Merge pull request #230157 from teutat3s/buildnpmpackage-docs
buildNpmPackage: document dontNpmBuild option
2023-06-28 18:33:02 -04:00
teutat3s 3a2cf5b3f5
buildNpmPackage: document dontNpmBuild option
document dontNpmInstall option
2023-06-28 23:49:29 +02:00