Commit Graph

2880 Commits

Author SHA1 Message Date
Benedikt Tissot
b28200aa23
texlive: document LuaLaTeX font cache (#280080)
lualatex assumes a writeable font cache relative to `$HOME`, for nix this has two implications.
First, the cache might diverge from the nix store if users use LuaLaTeX.
Second, `$HOME` needs to be set to a writable path in derivations.
2024-01-12 09:47:35 -06:00
hacker1024
a2cbeb19b4
docs/dart: Fix example autoPubspecLock syntax 2024-01-11 08:28:42 +11:00
hacker1024
778cefd464 buildDartApplication: Allow reading pubspec.lock with IFD 2024-01-10 20:29:53 +11:00
Bryan Lai
d7253bea6d doc: polish the docs of checkpointBuildTools
... following suggestions from @phip1611 and @infinisil.
2024-01-09 01:34:21 +08:00
Bryan Lai
df62c3c87f checkpointBuildTools: mkCheckpointedBuild -> mkCheckpointBuild
All other functions are in the form of `*{c,C}heckpointBuild*`, so we
deprecate the `mkCheckpointedBuild` function in favor of `mkCheckpointBuild`.

Also address some inconsistencies in the docs: some `buildOutput` should
actually be `incrementalBuildArtifacts`.
2024-01-08 19:42:16 +08:00
Maciej Krüger
349e0c2870
Merge pull request #263345 from hacker1024/feature/pub2nix
dart: Use Nix instead of Pub
2024-01-05 16:34:07 +01:00
DS
016680fcf6 doc: add documentation conventions to keep a consistent style 2024-01-04 15:44:05 -08:00
ajs124
12f45e5dc9 docs/ruby: update/drop references to old version 2024-01-02 15:30:07 +01:00
ajs124
02ad3159b0 ruby_2_7: remove 2024-01-02 15:30:06 +01:00
Martin Weinelt
01a2063317
doc/python: update buildPythonApplication example
It is fine to use `with` on the inputs, since that increases the
overall readability of the package.

Removes `wheel` from `nativeBuildInputs`, since it is a result of
cargo culting from an earlier setuptools example, that was wrong, and
it is not required, since it is provided by setuptools itself.
2024-01-01 23:39:38 +01:00
Silvan Mosberger
e5af05cbf3
Merge pull request #276821 from DanielSidhion/update-binarycache-section
doc: update mkBinaryCache section with admonitions and conventions
2023-12-31 23:00:06 +01:00
netali
fb8c363b6a
doc: fix python-updates branch name
The python-updates branch was formerly called python-unstable, but the
new branch name was never mentioned in the docs. This commit changes the
branch name in the docs to python-updates.
2023-12-28 21:54:36 +01:00
hacker1024
32e3ea18d5 buildDartApplication: Document customSourceBuilders 2023-12-26 18:48:12 +02:00
hacker1024
23952fb641 buildDartApplication: Remove depsListFile
We get a dependency list with pub2nix now. We can no longer easily distinguish between development dependency dependencies and regular dependency dependencies, but we weren't doing this anyway.
2023-12-26 18:48:12 +02:00
hacker1024
65d2cc04a3 dartHooks.dartConfigHook: Simplify packageRun function 2023-12-26 17:08:51 +02:00
hacker1024
d41348a68a dartHooks.dartConfigHook: Add packageRun utility 2023-12-26 17:08:51 +02:00
hacker1024
92809a1cc5 buildDartApplication: Document running build tools 2023-12-26 17:08:50 +02:00
hacker1024
dbc05b2c80 dart: Add headings to nix-shell documentation sections 2023-12-26 17:06:18 +02:00
hacker1024
7c9b754784 buildDartApplication: Document nix-shell usage 2023-12-26 17:06:18 +02:00
hacker1024
7c7cb95085 dart: Update documentation for pub2nix 2023-12-26 17:06:17 +02:00
DS
f0fb6f0a26 doc: update mkBinaryCache section with admonitions and conventions
The mkBinaryCache section now follows the convention of using one
line per sentence, as well as using admonitions for notes and
examples.

The example syntax was updated to define a fully-working nix package.
2023-12-25 17:34:59 -08:00
Daniel Sidhion
e525be5a07
doc: update the appimageTools section content and examples (#276029)
The following changes are made:
- Document how `wrapType2` and `wrapType1` are the same thing.
- Expand on how `wrapType2` works and additional arguments it uses.
- Document `extract` and show how it's used in combination with
  `wrapType2`.
- Provide full working examples using the new admonition syntax.
2023-12-23 11:36:25 +01:00
Wael Nasreddine
1bf9271a09
Merge pull request #274503 from lopter/patch-1
Golang docs: remove "-s" and "-w" from the ldflags example
2023-12-21 21:04:02 -08:00
Silvan Mosberger
59a6f908b5
Merge pull request #271797 from bzm3r/master
doc: diagram explaining what it means for a dependency to be propagated
2023-12-21 17:14:30 +01:00
Brian Merchant
b37adfc009 doc: Clarify dependency propagation 2023-12-21 17:11:47 +01:00
Daniel Sidhion
292ea0d917
doc: migrate examples in testers chapter to admonitions (#275791) 2023-12-21 12:54:32 +01:00
Silvan Mosberger
6afebb56f8
Merge pull request #271360 from mattpolzin/patch-1
doc: clarify stdenv phase flag attributes
2023-12-20 20:37:41 +01:00
Silvan Mosberger
f27bb1216c
Merge pull request #273773 from nbraud/scripts/doc/check-manpage-urls
maintainers: Add new script to check URLs in `doc/manpage-urls.json`
2023-12-20 19:33:32 +01:00
DS
b47d073e2d doc: add more details on testers.testVersion 2023-12-20 03:04:32 -08:00
Janne Heß
5eed5416ff
Merge pull request #167670 from messemar/incremental-builds
incremental builds: add derivation override functions
2023-12-19 11:37:15 +01:00
nicoo
38e912eaa3 doc/tests/manpage-urls.py: Add type annotations 2023-12-18 20:38:17 +00:00
nicoo
a687d6ab7e doc/manpage-urls.json: Fix link to gnunet's manual 2023-12-18 20:28:51 +00:00
nicoo
b1a96bbbf2 doc: Add test for broken links in manpage-urls.json 2023-12-18 20:28:51 +00:00
Valentin Gagarin
a0f94525b0 julia docs: one line per sentence
this implements the documentation team's style guide new material
2023-12-18 16:25:16 +01:00
Nick Cao
fc5c9afd4d
Merge pull request #225513 from codedownio/julia-modules
Build arbitrary Julia package environments in Nixpkgs
2023-12-18 09:58:27 -05:00
Danila Danko
ceb8e4efd9
doc: Update stdenv.chapter.md (#274706)
Extended genericBuild description
2023-12-16 13:32:15 +01:00
Louis Opter
2e3c2705b9
Remove "-s" and "-w" from the ldflags example
The go linker `-s` and `-w` flags respectively are for:

- Omit the symbol table and debug information.
- Omit the DWARF symbol table.

Those actions should be delegated to the fixup build phase instead.

See: https://discourse.nixos.org/t/why-do-so-many-go-packages-use-s-w-in-their-ldflags-it-breaks-dontfixup-dontstrip/36843
2023-12-15 09:31:00 -08:00
Tom McLaughlin
c8f0d302c1 julia: add documentation to manual + release note 2023-12-14 23:00:35 -08:00
messemar
5ebb78d952
doc: checkpointBuild: fix wording
Co-authored-by: Philipp Schuster <phip1611@gmail.com>
2023-12-13 11:15:29 +01:00
Valentin Gagarin
6d3f2550fd
Merge pull request #273384 from nbraud/doc/system-state
nixos/doc: Add chapter “necessary system state”
2023-12-13 08:54:09 +01:00
nicoo
6b6b12c27c doc/manpage-urls.json: Add *all* systemd manpages
and add the generating script to `maintainers/scripts/doc`
2023-12-12 23:06:11 +00:00
Martin Messer
15c2c6827b checkpointBuild: doc remove textual description in favor of an integrated example 2023-12-12 14:12:15 +01:00
messemar
0d6d654f36
doc: checkpointBuild: fix wording
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-12 13:19:21 +01:00
messemar
f61980dbf9
doc: fix typo in checkpoint build section
Co-authored-by: Markus Partheymueller <markus.partheymueller@cyberus-technology.de>
2023-12-12 10:43:54 +01:00
github-actions[bot]
958e403a78
Merge master into staging-next 2023-12-10 12:01:18 +00:00
Sophie Tauchert
3b40e1bd33 buildNimPackage: allow overriding nim package args
Without this, it's impossible to override the lockFile as the default
overrideAttrs is applied after the composition in buildNimPackage has
read the lock file and generated the nim flags from it.
2023-12-10 09:10:02 +00:00
Robert Hensing
8d20c2011e
Merge pull request #272183 from infinisil/nixpkgs-reference
doc: Rename to Nixpkgs reference manual and restate purpose
2023-12-10 07:07:20 +01:00
Silvan Mosberger
f5dafbfa83 doc: Rename to Nixpkgs reference manual and state purpose
For the time being, we're moving towards https://nix.dev/ containing
all tutorials and guides. The Nixpkgs manual is reinforced to be a
_reference_ manual. While it's not just reference for now, that's what
the docs team is working towards.

This commits rewrites the Nixpkgs manual introduction to reflect that
and point to some more useful links. The contribution docs are updated
similarly so it's not missed.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-08 01:26:31 +01:00
github-actions[bot]
728281e1ea
Merge master into staging-next 2023-12-08 00:02:27 +00:00
Connor Baker
bfaefd0873 cudaPackages: add docs 2023-12-07 16:45:56 +00:00