about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2021-06-28Merge pull request #124875 from hercules-ci/lib-sourcesRobert Hensing2-0/+3
lib.sources: docs, tests, refactoring
2021-06-26Merge pull request #128163 from nh2/github-actions-backport-link-to-criteriaDomen Kožar1-2/+2
Make backport bot link to criteria, make `CONTRIBUTING.md` more prominent
2021-06-26CONTRIBUTING.md: Move to repo root, where it is more visible.Niklas Hambüchen1-2/+2
We found that many users found it difficult to locate this document. Github supports it in the root, see: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
2021-06-22Merge branch 'master' into staging-nextMartin Weinelt2-26/+49
2021-06-22Refresh the Ocaml package examples; document `useDune2` (#127520)Graham Fawcett1-25/+48
The current example in the manual no longer builds, mainly because `useDune2 = true` is required, but also because the inputs have changed. The new examples are copied verbatim from nixpkgs.
2021-06-22doc/functions/generators: fix code blockrnhmjoj1-1/+1
Small fixup of 606bf6d.
2021-06-18Merge master into staging-nextgithub-actions[bot]1-2/+3
2021-06-18nixos/doc: Synchronize the Markdown generator with NixpkgsJan Tojnar1-2/+3
Switch to CommonMark with our extensions.
2021-06-16Merge staging-next into staginggithub-actions[bot]1-1/+19
2021-06-16Merge pull request #126591 from jtojnar/glib-networking-docJan Tojnar1-1/+19
doc/gnome: document GIO modules
2021-06-13Merge staging-next into staginggithub-actions[bot]1-1/+1
2021-06-12Merge pull request #125671 from SFrijters/doc-improve-make-cleanRyan Mulligan1-1/+1
doc: Clean up generated media directory
2021-06-11stdenv: introduce dontAddStaticConfigureFlagsAlyssa Ross1-1/+7
With removeUnknownConfigureFlags, it's impossible to express a package that needs --enable-static, but will not accept --disable-shared, without overriding the result of removeUnknownConfigureFlags _again_ in pkgs/top-level/static.nix. It would be much better (and more in line with the rest of Nixpkgs) if we encoded changes needed for static builds in package definitions themselves, rather than in an ever-expanding list in static.nix. This is especially true when doing it in static.nix is going to require multiple overrides to express what could be expressed with stdenv options. So as a step in that direction, and to fix the problem described above, here I replace removeUnknownConfigureFlags with a new stdenv option, dontAddStaticConfigureFlags. With this mechanism, a package that needs one but not both of the flags just needs to set dontAddStaticConfigureFlags and then set up configureFlags manually based on stdenv.hostPlatform.isStatic.
2021-06-11doc/functions/generators: convert to CommonMarkRyan Mulligan3-75/+57
2021-06-11doc/gnome: document GIO modulesJan Tojnar1-1/+19
In particular, that glib-networking is required for TLS support.
2021-06-10nixos/*: replace alsa* aliasesVladimír Čunát1-2/+2
The attributes got renamed in PR #126440 and in some places this caused evaluation errors, e.g. the tarball job was saying (locally) > attribute 'alsaUtils' missing, at /build/source/nixos/modules/services/audio/alsa.nix:6:4 and I suspect that trunk-combined jobset's failure to evaluate was also caused.
2021-06-09doc/manual: Add backport criteriaJonathan Ringer1-0/+11
2021-06-07doc/functions/prefer-remote-fetch: convert to CommonMarkRyan Mulligan3-22/+18
2021-06-07Merge pull request #125957 from ryantm/md-debugRyan Mulligan3-15/+6
doc/functions/debug: convert to CommonMark
2021-06-07doc/functions/debug: convert to CommonMarkRyan Mulligan3-15/+6
2021-06-07Merge pull request #125838 from jtojnar/strict-commonmarkRyan Mulligan48-415/+586
doc: Parse as CommonMark
2021-06-07doc: Use markdown syntax for xrefsJan Tojnar10-18/+48
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07doc: Build as CommonMarkJan Tojnar1-10/+15
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool. Since RFC 0072 agreed on CommonMark, let’s switch to that. We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
2021-06-07doc: prepare for commonmarkJan Tojnar44-388/+454
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
2021-06-06doc: Document markup syntaxJan Tojnar1-1/+71
Not depicted: - Diagrams using Lua filter and dot - fenced code attributes (enabled by the attributes extension)
2021-06-06Merge pull request #125702 from alarsyo/db-to-md-nix-gitignoreRyan Mulligan3-71/+50
doc: nix-gitignore to CommonMark
2021-06-05doc: nix-gitignore to CommonMarkAntoine Martin3-71/+50
Closes #125670
2021-06-05Merge pull request #125494 from siraben/remove-stdenv-libSandro1-3/+0
2021-06-05doc: Fix make in nix-shellJan Tojnar2-5/+4
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-06-05buildGoModule/buildGoPackage: Introduce ldflags argumentSilvan Mosberger1-8/+11
Previously it was not possible to define multiple ldflags, since only the last definition applies, and there's some quoting issues with `buildFlagsArray`. With the new `ldflags` argument it's possible to do this, e.g. ldflags = drv.ldflags or [] ++ [ "-X main.Version=1.0" ] can now properly append a flag without clearing all previous ldflags.
2021-06-04doc: Clean up generated media directoryStefan Frijters1-1/+1
pandoc uses ./media to extract media files - add it to the list of directories that need to be removed by `make clean`.
2021-06-03coding-conventions: remove reference to stdenv.libBen Siraphob1-3/+0
2021-06-03treewide: setuptools_scm -> setuptools-scmSandro Jäckel1-2/+2
2021-06-01doc: fix incorrect use of cargoDepsDaniël de Kok1-1/+1
Thanks to @bjornfor for reporting this error!
2021-05-29lib.sources: Generate docsRobert Hensing2-0/+3
2021-05-28Merge pull request #124739 from SFrijters/doc-fetchpatchMaximilian Bosch1-0/+10
doc/coding-conventions: Add documentation for fetchpatch optional arguments
2021-05-28doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters1-0/+10
2021-05-28Merge pull request #122158 from danieldk/import-cargo-lockDaniël de Kok1-0/+79
rustPlatform.buildRustPackage: support direct use of Cargo.lock
2021-05-28rustPlatform.buildRustPackage: support direct use of Cargo.lockDaniël de Kok1-0/+48
This change introduces the cargoLock argument to buildRustPackage, which can be used in place of cargo{Sha256,Hash} or cargoVendorDir. It uses the importCargoLock function to build the vendor directory. Differences compared to cargo{Sha256,Hash}: - Requires a Cargo.lock file. - Does not require a Cargo hash. - Retrieves all dependencies as fixed-output derivations. This makes buildRustPackage much easier to use as part of a Rust project, since it does not require updating cargo{Sha256,Hash} for every change to the lock file.
2021-05-28rustPlatform.importCargoLock: initDaniël de Kok1-0/+31
This function can be used to create an output path that is a cargo vendor directory. In contrast to e.g. fetchCargoTarball all the dependent crates are fetched using fixed-output derivations. The hashes for the fixed-output derivations are gathered from the Cargo.lock file. Usage is very simple, e.g.: importCargoLock { lockFile = ./Cargo.lock; } would use the lockfile from the current directory. The implementation of this function is based on Eelco Dolstra's import-cargo: https://github.com/edolstra/import-cargo/blob/master/flake.nix Compared to upstream: - We use fetchgit in place of builtins.fetchGit. - Sync to current cargo vendoring.
2021-05-27Merge pull request #120319 from fricklerhandwerk/docs-to-markdownRyan Mulligan7-878/+612
doc/using: convert to markdown
2021-05-25Merge pull request #124273 from NixOS/backporting-actionDomen Kožar1-0/+2
Add backporting action
2021-05-25backport action: document the workflowDomen Kožar1-0/+2
2021-05-25beam-packages: drop erlang R18 R19 R20 and cuterThomas Depierre1-2/+2
2021-05-25beam: fix documentationhappysalada1-2/+2
2021-05-24elixir: add deprecation schedule docshappysalada1-0/+6
2021-05-23doc/submitting-changes: should -> mustAlyssa Ross1-1/+1
To me, as a native English speaker, this doesn't change the meaning of the sentence at all. But to a non-native speaker, this can read like the staging-next rules are only recommendations. Let's make this clearer.
2021-05-17Merge pull request #123111 from hercules-ci/writeDirectReferencesToFileRobert Hensing1-0/+47
writeDirectReferencesToFile and maintenance
2021-05-17doc: Add anchors to dhall sectionsJan Tojnar1-7/+7
This will ensure the sections have stable links as well as prevent conflicts (pandoc uses heading text for ids and DocBook requires unique ids across the book).
2021-05-17Merge pull request #121252 from NixOS/SuperSandro2000-patch-1Sandro1-0/+12
doc/contributing: add unnecessary string conversions