about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2024-01-05Merge pull request #263345 from hacker1024/feature/pub2nixMaciej Krüger1-12/+54
dart: Use Nix instead of Pub
2024-01-04doc: add documentation conventions to keep a consistent styleDS1-0/+64
2024-01-02docs/ruby: update/drop references to old versionajs1241-3/+3
2024-01-02ruby_2_7: removeajs1241-2/+2
2024-01-01doc/python: update buildPythonApplication exampleMartin Weinelt1-6/+5
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.
2023-12-31Merge pull request #276821 from DanielSidhion/update-binarycache-sectionSilvan Mosberger1-21/+30
doc: update mkBinaryCache section with admonitions and conventions
2023-12-28doc: fix python-updates branch namenetali1-1/+1
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-26buildDartApplication: Document customSourceBuildershacker10241-0/+8
2023-12-26buildDartApplication: Remove depsListFilehacker10241-4/+0
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-26dartHooks.dartConfigHook: Simplify packageRun functionhacker10241-1/+1
2023-12-26dartHooks.dartConfigHook: Add packageRun utilityhacker10241-3/+4
2023-12-26buildDartApplication: Document running build toolshacker10241-0/+22
2023-12-26dart: Add headings to nix-shell documentation sectionshacker10241-3/+3
2023-12-26buildDartApplication: Document nix-shell usagehacker10241-0/+16
2023-12-26dart: Update documentation for pub2nixhacker10241-8/+7
2023-12-25doc: update mkBinaryCache section with admonitions and conventionsDS1-21/+30
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-23doc: update the appimageTools section content and examples (#276029)Daniel Sidhion1-25/+144
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-21Merge pull request #274503 from lopter/patch-1Wael Nasreddine1-1/+0
Golang docs: remove "-s" and "-w" from the ldflags example
2023-12-21Merge pull request #271797 from bzm3r/masterSilvan Mosberger1-4/+40
doc: diagram explaining what it means for a dependency to be propagated
2023-12-21doc: Clarify dependency propagationBrian Merchant1-4/+40
2023-12-21doc: migrate examples in testers chapter to admonitions (#275791)Daniel Sidhion1-44/+58
2023-12-20Merge pull request #271360 from mattpolzin/patch-1Silvan Mosberger1-3/+3
doc: clarify stdenv phase flag attributes
2023-12-20Merge pull request #273773 from nbraud/scripts/doc/check-manpage-urlsSilvan Mosberger3-1/+132
maintainers: Add new script to check URLs in `doc/manpage-urls.json`
2023-12-20doc: add more details on testers.testVersionDS1-20/+31
2023-12-19Merge pull request #167670 from messemar/incremental-buildsJanne Heß2-0/+37
incremental builds: add derivation override functions
2023-12-18doc/tests/manpage-urls.py: Add type annotationsnicoo1-5/+7
2023-12-18doc/manpage-urls.json: Fix link to gnunet's manualnicoo1-1/+1
2023-12-18doc: Add test for broken links in `manpage-urls.json`nicoo2-0/+129
2023-12-18julia docs: one line per sentenceValentin Gagarin1-7/+22
this implements the documentation team's style guide new material
2023-12-18Merge pull request #225513 from codedownio/julia-modulesNick Cao2-0/+55
Build arbitrary Julia package environments in Nixpkgs
2023-12-16doc: Update stdenv.chapter.md (#274706)Danila Danko1-1/+1
Extended genericBuild description
2023-12-15Remove "-s" and "-w" from the ldflags exampleLouis Opter1-1/+0
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-14julia: add documentation to manual + release noteTom McLaughlin2-0/+55
2023-12-13doc: checkpointBuild: fix wordingmessemar1-1/+1
Co-authored-by: Philipp Schuster <phip1611@gmail.com>
2023-12-13Merge pull request #273384 from nbraud/doc/system-stateValentin Gagarin1-3/+287
nixos/doc: Add chapter “necessary system state”
2023-12-12doc/manpage-urls.json: Add *all* systemd manpagesnicoo1-3/+287
and add the generating script to `maintainers/scripts/doc`
2023-12-12checkpointBuild: doc remove textual description in favor of an integrated ↵Martin Messer1-16/+26
example
2023-12-12doc: checkpointBuild: fix wordingmessemar1-5/+5
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-12doc: fix typo in checkpoint build sectionmessemar1-1/+1
Co-authored-by: Markus Partheymueller <markus.partheymueller@cyberus-technology.de>
2023-12-10Merge master into staging-nextgithub-actions[bot]4-14/+35
2023-12-10buildNimPackage: allow overriding nim package argsSophie Tauchert1-2/+15
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-10Merge pull request #272183 from infinisil/nixpkgs-referenceRobert Hensing3-12/+20
doc: Rename to Nixpkgs reference manual and restate purpose
2023-12-08doc: Rename to Nixpkgs reference manual and state purposeSilvan Mosberger3-12/+20
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-08Merge master into staging-nextgithub-actions[bot]1-9/+38
2023-12-07cudaPackages: add docsConnor Baker1-9/+38
2023-12-07checkpointBuild: fix whitespaces in documentationMartin Messer1-8/+6
2023-12-07rename: incremental -> checkpointed buildsMartin Messer2-13/+13
2023-12-07doc: add section about checkpointed buildMartin Messer2-0/+29
2023-12-07Merge master into staging-nextgithub-actions[bot]1-1/+1
2023-12-06CONTRIBUTING.md: Update markdown emphasising syntaxSilvan Mosberger1-1/+1
GitHub supported special markdown syntax for emphasising blocks for some time. This was however a beta feature, and still is, so it's subject to changes. Recently such a change happened: The syntax is different now. See https://github.com/orgs/community/discussions/16925 for more information