about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2018-11-07Merge pull request #49684 from Zimmi48/dune-packageJörg Thalheim2-0/+102
buildDunePackage: add support function and use it in a few packages
2018-11-07Remove preferLocalBuild documentationEelco Dolstra1-16/+1
It's incorrect (preferLocalBuild does not prevent uploading to binary caches) and is not a stdenv attribute (it's already documented in the Nix manual).
2018-11-07duneBuildPackage: documentThéo Zimmermann2-0/+102
2018-11-07Merge pull request #44439 from Ekleog/meta-testsTimo Kaufmann1-0/+55
[RFC] Use `meta.tests` to link from packages to the tests that test them
2018-11-05docs: Remove redundancyJan Path1-2/+2
2018-11-04python34: removeFrederik Rietdijk1-5/+4
Python 3.4 will receive it's final patch release in March 2019 and there won't be any releases anymore after that, so also not during NixOS 2019.03. Python 3.4 is not used anymore in Nixpkgs. In any case, migrating code from 3.4 to 3.4+ is trivial.
2018-10-30pythonPackages.pythondaemon: rename to pythonPackages.python-daemonBenjamin Hipple1-1/+1
This commit renames the pythondaemon module to match its module name, github name, and pypi name, which makes it easier to find and reference. In order to avoid breaking any external users, I've left an alias with a deprecated warning.
2018-10-30dovecot, opensmtpd: add link to test in `meta.tests`Léo Gaspard1-0/+55
Rationale --------- Currently, tests are hard to discover. For instance, someone updating `dovecot` might not notice that the interaction of `dovecot` with `opensmtpd` is handled in the `opensmtpd.nix` test. And even for someone updating `opensmtpd`, it requires manual work to go check in `nixos/tests` whether there is actually a test, especially given not so many packages in `nixpkgs` have tests and this is thus most of the time useless. Finally, for the reviewer, it is much easier to check that the “Tested via one or more NixOS test(s)” has been checked if the file modified already includes the list of relevant tests. Implementation -------------- Currently, this commit only adds the metadata in the package. Each element of the `meta.tests` attribute is a derivation that, when it builds successfully, means the test has passed (ie. following the same convention as NixOS tests). Future Work ----------- In the future, the tools could be made aware of this `meta.tests` attribute, and for instance a `--with-tests` could be added to `nix-build` so that it also builds all the tests. Or a `--without-tests` to build without all the tests. @Profpatsch described in his NixCon talk such systems. Another thing that would help in the future would be the possibility to reasonably easily have cross-derivation nix tests without the whole NixOS VM stack. @7c6f434c already proposed such a system. This RFC currently handles none of these concerns. Only the addition of `meta.tests` as metadata to be used by maintainers to remember to run relevant tests.
2018-10-30Add mention of nix-prefetch-github. (#49336)Théo Zimmermann1-1/+4
2018-10-26doc: apply `make format`Jörg Thalheim2-9/+9
2018-10-26doc: extend breakpointHook documentationJörg Thalheim1-10/+13
2018-10-26Merge pull request #49126 from das-g/stdenv-docsJörg Thalheim1-2/+2
minor fixes in Nixpkgs stdenv docs
2018-10-26nixpkgs docs: add missing spaces between wordsRaphael Borun Das Gupta1-2/+2
2018-10-26nixpkgs docs: remove spurious ">"Raphael Borun Das Gupta1-1/+1
2018-10-25Merge pull request #49026 from schmittlauch/doc-vimJörg Thalheim1-0/+4
clarifying `name` arg determines vim command name
2018-10-25Merge pull request #42371 from Mic92/nix-breakpointsJörg Thalheim1-0/+19
breakpointHook: add for debugging failing builds
2018-10-25doc/breakpointHook: add documentationJörg Thalheim1-0/+19
2018-10-24clarifying `name` arg determines vim command nameTrolli Schmittlauch1-0/+4
The `name` arg of `vim_configurable.customize` does not only determine the package name, but also the name of the command/ executable to be called. In my opinion this is not documented properly and finding that out took me several hours.
2018-10-23Merge pull request #47430 from roberth/nixpkgs-extendJohn Ericson2-82/+122
pkgs.extend for adding overlays
2018-10-23nixpkgs docs: Fix tiny typo (#48477)Ingo Blechschmidt1-2/+2
2018-10-23weechat: add perl.withPackages (#48815)Alyssa Ross1-4/+4
Allows for adding Perl libraries in the same way as for Python. Doesn't really need to be a function, since there's only one perlPackages in nixpkgs, but I went for consistency with the python plugin.
2018-10-19doc: Add link from overrides to overlaysRobert Hensing1-2/+3
2018-10-19coqPackages: update documentation to mention coq.ocamlPackages attributeThéo Zimmermann1-4/+3
2018-10-18doc: Improve overrides and overlays documentationRobert Hensing2-92/+114
2018-10-18nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override ↵Robert Hensing2-3/+20
section
2018-10-15Merge pull request #48463 from Ekleog/release-notes-licenseGraham Christensen1-1/+2
release-notes/18-09: add licenses marked as unfree
2018-10-15package-notes: line wrap by auto-cleanupLéo Gaspard1-1/+2
2018-10-12nixpkgs docs: document recursivelyUpdateGraham Christensen1-0/+57
2018-10-12nixpkgs docs: document recursivelyUpdateUntilGraham Christensen1-0/+108
2018-10-12nixpkgs docs: document zipAttrsGraham Christensen1-1/+44
2018-10-12nixpkgs docs: document zipAttrsWithGraham Christensen1-0/+79
2018-10-12nixpkgs docs: Clarify zipAttrsWithNames's docsGraham Christensen1-1/+1
2018-10-12nixpkgs docs: document zipAttrsWithNamesGraham Christensen1-0/+88
2018-10-12nixpkgs docs: document optionalAttrsGraham Christensen1-0/+53
2018-10-12nixpkgs docs: document toDerivationGraham Christensen1-0/+26
2018-10-12nixpkgs docs: document isDerivationGraham Christensen1-0/+43
2018-10-12nixpkgs docs: document genAttrsGraham Christensen1-0/+59
2018-10-12nixpkgs docs: document mapAttrsRecursiveCondGraham Christensen1-0/+123
2018-10-12nixpkgs docs: finish up mapAttrsRecursiveGraham Christensen1-0/+82
2018-10-12Update with code review feedback; add example python applicationBenjamin Hipple1-2/+32
2018-10-12python: update documentationBenjamin Hipple1-23/+25
This touches up a handful of places in the python documentation to try to make the current best-practices more obvious. In particular, I often find the function signatures (what to pass, what not to pass) confusing and have added them to the docs. Also updated the metas to be more consistent with the most frequently used modern style.
2018-10-05Generate links to function definitionsGraham Christensen7-4/+133
Hydra passes the full revision in to the input, which we pass through. If we don't get this ,we try to get it from other sources, or default to master which should have the definition in a close-ish location. All published docs should have theURL resolve properly, only local hackers will have the link break.
2018-10-05nixpkgs: Start documenting library functions in XMLGraham Christensen5-2/+1068
Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
2018-10-03Merge pull request #47688 from grahamc/doc-breakout-functionsGraham Christensen11-1065/+1102
nixpkgs docs: breakout functions
2018-10-02nixpkgs docs: ReformatGraham Christensen8-767/+778
2018-10-02nixpkgs docs: Rebuild manual-full if nested XML docs changeGraham Christensen1-1/+1
2018-10-02shell functions: rewrite as xmlGraham Christensen3-23/+28
2018-10-02nixpkgs docs: move shell section to its own fileGraham Christensen2-1/+1
2018-10-02nixpkgs docs: move dockertool to its own fileGraham Christensen2-563/+567
2018-10-02nixpkgs docs: move fhs-environments to its own fileGraham Christensen2-141/+145
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-09-17 16:20:11 +0000