Commit graph

33 commits

Author SHA1 Message Date
Eric Sagnes 2b1d67a275 manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 15:15:02 +01:00
Eric Sagnes e14de56613 module system: extensible option types 2016-11-06 00:05:58 +01:00
Eric Sagnes 1fe1cdecb2 types: loeOf -> listOf 2016-11-05 21:46:42 +01:00
Jörg Thalheim da5c0220aa Merge pull request #17622 from rvl/nixos-manual-writing-documentation
Add documentation about writing NixOS documentation
2016-10-09 13:39:08 +02:00
Pascal Bach 8c053633df Fix xml validation error in NixOS releases documentation 2016-10-07 22:49:05 +02:00
Domen Kožar ed6ea7416a Document NixOS release process #4442 2016-10-07 09:49:47 +02:00
Alexander Ried 0a0347c589 reviewing-contributions.xml: fix typo 2016-10-05 10:40:32 +02:00
Eric Sagnes caef192c81 nixos-manual: reviewing chapter cleanup 2016-10-02 00:50:16 +09:00
Eric Sagnes bf86f9f016 improvements from feedback 2 2016-10-01 19:02:09 +09:00
Eric Sagnes 7ad26bdc6e improvements from feedback 2016-09-28 11:05:22 +09:00
Eric Sagnes 3504a546e6 [WIP] typo fixes, few improvements 2016-09-27 00:36:59 +09:00
Eric Sagnes 8d656d2ca0 nixos-doc: add reviewing-contributions 2016-09-26 15:44:06 +09:00
Eric Sagnes b32252ddfa NixOS manual: add module option types doc (#18525) 2016-09-13 07:04:02 +02:00
Rodney Lorrimar 4908d7bf20 nixos-manual: Add a chapter about writing documentation
It's more about the practical side of DocBook-wrangling than anything
else.
2016-09-11 13:21:09 +01:00
Robin Gloster 6808de76e6
nixos doc: module meta attribute section cleanup 2016-08-29 09:34:24 +00:00
Eric Sagnes aa8e663b6e nixos doc: add modules meta-attributes (#18078) 2016-08-29 07:54:25 +00:00
Wilhelm Schuster 5f8d14546b Manual: Explicitly mark commands that require to be run as root (#15589)
* manual: Mark commands that require root

Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.

* manual: Add note about commands that require root
2016-06-01 15:23:32 +01:00
Joachim Fasting d9796f44f6
manual: minor cleanups 2016-05-22 20:01:52 +02:00
Eelco Dolstra 25387a1bed nixos-checkout: Remove
This command was useful when NixOS was spread across multiple
repositories, but now it's pretty pointless (and obfuscates what
happens, i.e. "git clone git://github.com/NixOS/nixpkgs.git").
2016-04-20 20:57:02 +02:00
Eelco Dolstra f3d94cfc23 Revert "Add the tool "nixos-typecheck" that can check an option declaration to:"
This reverts commit cad8957eab. It
breaks NixOps, but more importantly, such major changes to the module
system really need to be reviewed.
2016-03-01 20:52:06 +01:00
Thomas Strobel cad8957eab Add the tool "nixos-typecheck" that can check an option declaration to:
- Enforce that an option declaration has a "defaultText" if and only if the
   type of the option derives from "package", "packageSet" or "nixpkgsConfig"
   and if a "default" attribute is defined.

 - Enforce that the value of the "example" attribute is wrapped with "literalExample"
   if the type of the option derives from "package", "packageSet" or "nixpkgsConfig".

 - Warn if a "defaultText" is defined in an option declaration if the type of
   the option does not derive from "package", "packageSet" or "nixpkgsConfig".

 - Warn if no "type" is defined in an option declaration.
2016-02-29 01:09:00 +01:00
Dan Peebles e409d0fed3 nixos: update-locatedb - harden via systemd (#7220)
Also, use systemd timers.

Most of the work is by @thoughtpolice but I changed enough of it to warrant changing commit author.
2016-01-23 20:44:30 +00:00
Eelco Dolstra 214d4fb73c Allow options with type "package" to be store paths
For example, this allows writing

  nix.package = /nix/store/786mlvhd17xvcp2r4jmmay6jj4wj6b7f-nix-1.10pre4206_896428c;

Also, document types.package in the manual.
2015-08-07 03:09:57 +02:00
Eelco Dolstra c46e424c8f Remove obsolete reference to /media 2015-07-17 11:27:33 +02:00
aszlig 8be00dc71d
nixos/test-driver: Make tesseract OCR optional.
By default this is now enabled, and it has to be explicitely enabled
using "enableOCR = true". If it is set to false, any usage of
getScreenText or waitForText will fail with an error suggesting to pass
enableOCR.

This should get rid of the rather large dependency on tesseract which
we don't need for most tests.

Note, that I'm using system("type -P") here to check whether tesseract
is in PATH. I know it's a bashism but we already have other bashisms
within the test scripts and we also run it with bash, so IMHO it's not a
problem here.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
2015-05-22 07:21:58 +02:00
aszlig 8bd025a75e
nixos/test-driver: Add new waitForText function.
As promised in the previous commit, this can be used similarly to
$machine->waitForWindow, where you supply a regular expression and it's
retrying OCR until the regexp matches.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
2015-05-21 19:55:21 +02:00
aszlig 235c2228ca
nixos/test-driver: Add new getScreenText function.
Basically, this creates a screenshot and throws tesseract at it to
recognize the characters from the screenshot. In order to produce a
result that is well enough, we're using lanczos scaling and scale the
image up to 400% of its original size.

This provides the base functionality for a new Machine method which will
be called waitForText. I originally had that idea long ago when writing
the VM tests for VirtualBox and Chromium, but thought it would be
disproportionate to the case.

The downside however is that VM tests now depend on tesseract, but given
the average runtime of our tests it really shouldn't have a too big
impact and it's only a runtime dependency after all.

Another issue is that the OCR process takes quite some time to finish,
but IMHO it's better (as in more deterministic) than to rely on sleep().

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
2015-05-21 19:55:21 +02:00
Eelco Dolstra 10ce7ae769 Document the nixpkgs-channels repo
This replaces update-channel-branches.sh with standard Git
invocations.
2015-05-20 14:20:53 +02:00
Domen Kožar f39b1ead2a manual: re-add running nixos tests sections 2015-04-21 02:28:59 -04:00
Nicolas B. Pierron 9334085e80 update-channel-branches.sh: Add verbosity to improve the user experience, and update NixOS documentation. 2014-12-18 22:25:21 +01:00
Domen Kožar 48a282b913 http://nixos.org -> https://nixos.org
(cherry picked from commit 78bb17dd22e4da4e3810fbc78185d73bb25ea73e)
Signed-off-by: Domen Kožar <domen@dev.si>
2014-12-14 11:26:45 +01:00
Domen Kožar b4cedc7965 nixos: reverse logic in nixos interactive tests documentation 2014-11-27 20:01:18 +01:00
Mikey Ariel a099ca4505 Chunk NixOS manual
[Squashed commits to make git blame etc. more likely to work. -ED]
2014-08-26 19:03:49 +02:00