summary refs log tree commit diff
path: root/doc
Commit message (Collapse)AuthorAge
* Merge pull request #44439 from Ekleog/meta-testsTimo Kaufmann2018-11-07
|\ | | | | [RFC] Use `meta.tests` to link from packages to the tests that test them
| * dovecot, opensmtpd: add link to test in `meta.tests`Léo Gaspard2018-10-30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | docs: Remove redundancyJan Path2018-11-05
| |
* | python34: removeFrederik Rietdijk2018-11-04
| | | | | | | | | | | | | | | | 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.
* | pythonPackages.pythondaemon: rename to pythonPackages.python-daemonBenjamin Hipple2018-10-30
| | | | | | | | | | | | 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.
* | Add mention of nix-prefetch-github. (#49336)Théo Zimmermann2018-10-30
|/
* doc: apply `make format`Jörg Thalheim2018-10-26
|
* doc: extend breakpointHook documentationJörg Thalheim2018-10-26
|
* Merge pull request #49126 from das-g/stdenv-docsJörg Thalheim2018-10-26
|\ | | | | minor fixes in Nixpkgs stdenv docs
| * nixpkgs docs: add missing spaces between wordsRaphael Borun Das Gupta2018-10-26
| |
| * nixpkgs docs: remove spurious ">"Raphael Borun Das Gupta2018-10-26
| |
* | Merge pull request #49026 from schmittlauch/doc-vimJörg Thalheim2018-10-25
|\ \ | |/ |/| clarifying `name` arg determines vim command name
| * clarifying `name` arg determines vim command nameTrolli Schmittlauch2018-10-24
| | | | | | | | | | | | | | | | 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.
* | Merge pull request #42371 from Mic92/nix-breakpointsJörg Thalheim2018-10-25
|\ \ | |/ |/| breakpointHook: add for debugging failing builds
| * doc/breakpointHook: add documentationJörg Thalheim2018-10-25
| |
* | Merge pull request #47430 from roberth/nixpkgs-extendJohn Ericson2018-10-23
|\ \ | | | | | | pkgs.extend for adding overlays
| * | doc: Add link from overrides to overlaysRobert Hensing2018-10-19
| | |
| * | doc: Improve overrides and overlays documentationRobert Hensing2018-10-18
| | |
| * | nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override ↵Robert Hensing2018-10-18
| | | | | | | | | | | | section
* | | nixpkgs docs: Fix tiny typo (#48477)Ingo Blechschmidt2018-10-23
| | |
* | | weechat: add perl.withPackages (#48815)Alyssa Ross2018-10-23
| |/ |/| | | | | | | 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.
* | coqPackages: update documentation to mention coq.ocamlPackages attributeThéo Zimmermann2018-10-19
|/
* Merge pull request #48463 from Ekleog/release-notes-licenseGraham Christensen2018-10-15
|\ | | | | release-notes/18-09: add licenses marked as unfree
| * package-notes: line wrap by auto-cleanupLéo Gaspard2018-10-15
| |
* | nixpkgs docs: document recursivelyUpdateGraham Christensen2018-10-12
| |
* | nixpkgs docs: document recursivelyUpdateUntilGraham Christensen2018-10-12
| |
* | nixpkgs docs: document zipAttrsGraham Christensen2018-10-12
| |
* | nixpkgs docs: document zipAttrsWithGraham Christensen2018-10-12
| |
* | nixpkgs docs: Clarify zipAttrsWithNames's docsGraham Christensen2018-10-12
| |
* | nixpkgs docs: document zipAttrsWithNamesGraham Christensen2018-10-12
| |
* | nixpkgs docs: document optionalAttrsGraham Christensen2018-10-12
| |
* | nixpkgs docs: document toDerivationGraham Christensen2018-10-12
| |
* | nixpkgs docs: document isDerivationGraham Christensen2018-10-12
| |
* | nixpkgs docs: document genAttrsGraham Christensen2018-10-12
| |
* | nixpkgs docs: document mapAttrsRecursiveCondGraham Christensen2018-10-12
| |
* | nixpkgs docs: finish up mapAttrsRecursiveGraham Christensen2018-10-12
|/
* Update with code review feedback; add example python applicationBenjamin Hipple2018-10-12
|
* python: update documentationBenjamin Hipple2018-10-12
| | | | | | | | | | 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.
* Generate links to function definitionsGraham Christensen2018-10-05
| | | | | | | | | | 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.
* nixpkgs: Start documenting library functions in XMLGraham Christensen2018-10-05
| | | | | | Covers assert functions and about half of the attrsets functions. Some internal consistency around IDs could be improved.
* Merge pull request #47688 from grahamc/doc-breakout-functionsGraham Christensen2018-10-03
|\ | | | | nixpkgs docs: breakout functions
| * nixpkgs docs: ReformatGraham Christensen2018-10-02
| |
| * nixpkgs docs: Rebuild manual-full if nested XML docs changeGraham Christensen2018-10-02
| |
| * shell functions: rewrite as xmlGraham Christensen2018-10-02
| |
| * nixpkgs docs: move shell section to its own fileGraham Christensen2018-10-02
| |
| * nixpkgs docs: move dockertool to its own fileGraham Christensen2018-10-02
| |
| * nixpkgs docs: move fhs-environments to its own fileGraham Christensen2018-10-02
| |
| * nixpkgs docs: move debug to its own fileGraham Christensen2018-10-02
| |
| * nixpkgs docs: move generators to its own fileGraham Christensen2018-10-02
| |
| * nixpkgs docs: move overrides to its own fileGraham Christensen2018-10-02
| |
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-05-18 11:53:05 +0000