summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2013-12-14guix package: allow multiple arguments after -i, -r, and -u.Mark H Weaver
* guix/scripts/package.scm (%options): Adapt option processors to accept and return a second seed value: 'arg-handler', which handles bare arguments (if not false). The install, remove, and upgrade option processors return an arg-handler that repeat the same operation. All other option processors return #f as the arg-handler. Make the arguments to install and remove optional. The upgrade option processor deletes (upgrade . #f) from the alist before adding a new entry. (guix-package): Procedures passed to 'args-fold*' accept the new seed value 'arg-handler'. The 'operand-proc' uses 'arg-handler' (if not false). * doc/guix.texi (Invoking guix package): Update docs. * tests/guix-package.sh: Add test.
2013-12-11doc: Slightly improve the "System Configuration" node.Ludovic Courtès
* doc/guix.texi (System Configuration): Add paragraph on upgrades and rollback, moved from "Using the Configuration System". (Using the Configuration System): Change variable name to 'komputilo'. Add xref to "Package Modules".
2013-12-10doc: First stab at documenting whole-system configuration.Ludovic Courtès
* doc/guix.texi (Features): Add xref to "Using the Configuration System". (System Configuration, Using the Configuration System, Defining Services): New nodes.
2013-12-04derivations: Use more keyword parameters for 'build-expression->derivation'.Ludovic Courtès
* guix/derivations.scm (build-expression->derivation): Turn 'system' and 'inputs' into keyword parameters. Adjust callers accordingly. * gnu/system/linux.scm, gnu/system/vm.scm, guix/build-system/cmake.scm, guix/build-system/gnu.scm, guix/build-system/perl.scm, guix/build-system/python.scm, guix/build-system/trivial.scm, guix/download.scm, guix/packages.scm, guix/profiles.scm, guix/scripts/pull.scm, tests/derivations.scm, tests/guix-build.sh, tests/monads.scm, tests/store.scm, tests/union.scm: Adjust users of 'build-expression->derivation' and 'derivation-expression' accordingly. * doc/guix.texi (Derivations): Adjust 'build-expression->derivation' documentation accordingly. (The Store Monad): Likewise for 'derivation-expression'.
2013-11-23doc: List the supported platforms.Ludovic Courtès
* doc/guix.texi (GNU Distribution): List the supported platforms.
2013-11-19doc: Link to package-list.html.Ludovic Courtès
* doc/guix.texi (GNU Distribution): Add link to package-list.html.
2013-11-18guix build: '-e' can be passed a monadic thunk.Ludovic Courtès
* guix/ui.scm (read/eval): New procedure. (read/eval-package-expression): Use it. * guix/scripts/build.scm (derivations-from-package-expressions): Rename to... (derivation-from-expression): ... this. Accept procedures, under the assumption that they are monadic thunk. (show-help): Adjust accordingly. (guix-build): Ditto. * tests/guix-build.sh: Add test. * doc/guix.texi (Invoking guix build): Augment description of '-e'.
2013-11-18doc: Mention Linux containers; emphasize reproducible builds.Ludovic Courtès
* doc/guix.texi (Introduction): Use "containers" instead of "chroots". (Invoking guix-daemon): Add @cindex entries. Mention the Linux container features. (Features): Add sentence on build reproducibility.
2013-11-12guix build: Add '--log-file'.Ludovic Courtès
* guix/scripts/build.scm (show-help): Add '--log-file'. (%options): Likewise. (guix-build): Set %FILE-PORT-NAME-CANONICALIZATION. Honor '--log-file'. * tests/guix-build.sh: Add '--log-file' tests. * doc/guix.texi (Invoking guix build): Document '--log-file'.
2013-11-07packages: Add a 'snippet' field to <origin>.Ludovic Courtès
* guix/packages.scm (<origin>): Add 'snippet', 'modules', and 'imported-modules' fields. (patch-and-repack): Make 'inputs' a keyword parameter. Add 'snippet', 'modules', and 'imported-modules' parameters. Accept SOURCE as a raw file name. Insert SNIPPET in BUILDER. Pass IMPORTED-MODULES to 'build-expression->derivation'. (package-source-derivation): Pass the extra arguments to 'patch-and-repack'. * tests/packages.scm ("package-source-derivation, snippet"): New test. * doc/guix.texi (Defining Packages): Mention the 'patches' and 'snippet' fields. (Invoking guix build): Tell that --source has patches and snippets applied. (Software Freedom): Mention packages that contain non-free code.
2013-11-07doc: Document current security issue with substitutes.Ludovic Courtès
Suggested by Mark H. Weaver <mhw@netris.org>. * doc/guix.texi (Features): Add note about unauthenticated binaries.
2013-11-07doc: Improve documentation of '--no-substitutes'.Ludovic Courtès
Suggested by Mark H. Weaver <mhw@netris.org>. * doc/guix.texi (Invoking guix package): Spell out the --no-substitutes documentation. (Invoking guix build): Use the more complete --no-substitutes documentation. (Invoking guix-daemon): Explain the interaction with what clients ask for.
2013-11-02doc: Document the syntax of the '--remove' argument.Ludovic Courtès
* doc/guix.texi (Invoking guix package): Document the syntax of '--remove' patterns.
2013-10-29doc: Augment the "Porting" section.Ludovic Courtès
Reported by Andreas Enge <andreas@enge.fr>. * doc/guix.texi (Porting): Document needed changes to (gnu packages bootstrap) and (gnu packages linux).
2013-10-17doc: Improve the copyright notice.Nikita Karetnikov
2013-10-13doc: Document "guix pull --url".Ludovic Courtès
* doc/guix.texi (Invoking guix pull): Add --url.
2013-10-03Add (guix monads).Ludovic Courtès
* guix/monads.scm: New file. * tests/monads.scm: New file. * Makefile.am (MODULES): Add guix/monads.scm. (SCM_TESTS): Add tests/monads.scm. * doc/guix.texi (The Store Monad): New node. (The Store): Reference it.
2013-09-27doc: Fix typos.Nikita Karetnikov
* doc/guix.texi: Fix typos.
2013-09-27doc: Link from "guix gc" to '--delete-generations'.Ludovic Courtès
* doc/guix.texi (Invoking guix package): Mention that deleting generations prevents roll-back. (Invoking guix gc): Link to '--delete-generations'.
2013-09-27guix package: '--delete-generations' deletes generations older than specified.Ludovic Courtès
* guix/scripts/package.scm (matching-generations): Add 'duration-relation' keyword parameter. (guix-package)[process-action](delete-generations): Pass #:duration-relation >. * tests/guix-package.sh: Add test. * doc/guix.texi (Invoking guix package): Clarify the meaning of durations for '--list-durations' and '--delete-durations'.
2013-09-26guix package: Add '--delete-generations'.Nikita Karetnikov
* guix/scripts/package.scm (switch-to-previous-generation): New function. (roll-back): Use the new function instead of 'switch-link'. (show-help): Add '--delete-generations'. (%options): Likewise. (guix-package)[process-actions]: Add 'current-generation-number', 'display-and-delete', and 'delete-generation'. Add support for '--delete-generations', and reindent the code. * tests/guix-package.sh: Test '--delete-generations'. * doc/guix.texi (Invoking guix-package): Document '--delete-generations'.
2013-09-25guix package: Do not list the zeroth generation.Nikita Karetnikov
* guix/scripts/package.scm (guix-package)[process-query]: Change 'list-generation' to not list the zeroth generation. * tests/guix-package.sh: Test it. * doc/guix.texi (Invoking guix package): Document it, and use the right term when talking about generations.
2013-09-23doc: Document '--list-generations' among the query options.Ludovic Courtès
* doc/guix.texi (Invoking guix package): Move '--list-generations' below "In addition to these actions".
2013-09-23guix package: Show most recently installed packages last.Ludovic Courtès
Suggested by Andreas Enge <andreas@enge.fr>. * guix/scripts/package.scm (guix-package)[list-generations, list-installed]: Reverse the result of 'manifest-packages'. * doc/guix.texi (Invoking guix package): Document the order of packages for '--list-generations' and '--list-installed'.
2013-09-19guix package: Add '--list-generations'.Nikita Karetnikov
* guix/scripts/package.scm: Import (srfi srfi-19). (generation-time, matching-generations): New functions. (show-help): Add '--list-generations'. (%options): Likewise. (guix-package)[process-query]: Add support for '--list-generations'. * guix/ui.scm: Import (srfi srfi-19) and (ice-9 regex). (string->generations, string->duration): New functions. * tests/guix-package.sh: Test '--list-generations'. * tests/ui.scm: Import (srfi srfi-19). Test 'string->generations' and 'string->duration'. * doc/guix.texi (Invoking guix-package): Document '--list-generations'.
2013-09-18derivations: 'derivation' and related procedures return a single value.Ludovic Courtès
* guix/derivations.scm (derivation->output-path, derivation->output-paths): New procedures. (derivation-path->output-path): Use 'derivation->output-path'. (derivation-path->output-paths): Use 'derivation->output-paths'. (derivation): Accept 'derivation?' objects as inputs. Return a single value. (build-derivations): New procedure. (compiled-modules): Use 'derivation->output-paths'. (build-expression->derivation)[source-path]: Add case for when the input matches 'derivation?'. [prologue]: Accept 'derivation?' objects in INPUTS. [mod-dir, go-dir]: Use 'derivation->output-path'. * guix/download.scm (url-fetch): Adjust to the single-value return. * guix/packages.scm (package-output): Use 'derivation->output-path'. * guix/scripts/build.scm (guix-build): When the argument is 'derivation-path?', pass it through 'read-derivation'. Use 'derivation-file-name' to print out the .drv file names, and to register them. Use 'derivation->output-path' instead of 'derivation-path->output-path'. * guix/scripts/package.scm (roll-back): Adjust to the single-value return. (guix-package): Use 'derivation->output-path'. * guix/ui.scm (show-what-to-build): Adjust to deal with 'derivation?' objects instead of .drv file names. * gnu/system/grub.scm (grub-configuration-file): Use 'derivation->output-path' instead of 'derivation-path->output-path'. * gnu/system/vm.scm (qemu-image, system-qemu-image): Likewise. * tests/builders.scm, tests/derivations.scm, tests/packages.scm, tests/store.scm, tests/union.scm: Adjust to the new calling convention. * doc/guix.texi (Defining Packages, The Store, Derivations): Adjust accordingly.
2013-09-11store: The 'references' parameter of 'add-text-to-store' is now optional.Ludovic Courtès
* guix/store.scm (add-text-to-store): Make 'references' optional. * tests/store.scm ("dead-paths", "references"): Use 'add-text-to-store' with no optional argument. * doc/guix.texi (The Store): Adjust accordingly.
2013-08-31doc: Stylistic changes to "Packaging Guidelines"Andreas Enge
2013-08-30doc: Remove an extra space after @ref.Nikita Karetnikov
2013-08-29doc: Add duplicate copyright notice again.Andreas Enge
* doc/guix.texi: Add second copyright notice again inside @ifinfo, needed since the first one does not appear in the info output. Partially undoes commit da7cabd.
2013-08-29doc: Fix the image size in PDF/PS/DVI output.Ludovic Courtès
* doc/guix.texi (Bootstrapping): Specify an image width for the TeX output. Before that, the image would be much wider than the US Letter page width.
2013-08-29build: Build docs from the top-level Makefile.Ludovic Courtès
This undoes commit 575ed8d ("doc: Create own Makefile.am in subdirectory."), and fixes a bug whereby "make pdf" or "make ps" wouldn't do anything. * doc/Makefile.am: Remove. * doc.am: New file. Use `-local' rules to build the image. * Makefile.am: Include it. * configure.ac: Use `-Woverride' to avoid undesired overridding of Automake rules.
2013-08-28doc: Add package guidelines for names and numbers.Andreas Enge
* doc/guix.texi: Three new subsections.
2013-08-28doc: Shuffle some text around.Andreas Enge
* doc/guix.texi: Drop duplicate copyright notice, start section "Packaging Guidelines" with existant text.
2013-08-28doc: Create own Makefile.am in subdirectory.Andreas Enge
* doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28derivations: Rename #:dependency-graphs to #:references-graphs.Ludovic Courtès
* guix/derivations.scm (derivation, build-expression->derivation): Rename #:dependency-graphs to #:references-graphs, for consistency in the terminology. * tests/derivations.scm: Adjust accordingly.
2013-08-26derivations: Add #:dependency-graphs to `build-expression->derivation'.Ludovic Courtès
* guix/derivations.scm (build-expression->derivation): Add #:dependency-graphs keyword argument. Pass it to `derivation'. * tests/derivations.scm ("build-expression->derivation with #:dependency-graphs"): New test. * doc/guix.texi (Derivations): Update `build-expression->derivation' description.
2013-08-26derivations: Add #:dependency-graphs `derivation' parameter.Ludovic Courtès
* guix/derivations.scm (derivation): Add `dependency-graphs' keyword parameter; honor it. * tests/derivations.scm (bootstrap-binary): New procedure. (%bash): Use it. (%mkdir): New variable. (directory-contents): Add `slurp' optional parameter. ("derivation with #:dependency-graphs"): New test. * doc/guix.texi (Derivations): Update accordingly.
2013-08-26derivations: Move 3 positional parameters into keyword parameters.Ludovic Courtès
* guix/derivations.scm (derivation): Turn `system', `env-vars', and `inputs' into keyword parameters. (build-expression->derivation): Adjust accordingly. * gnu/packages/bootstrap.scm (%bootstrap-guile): Likewise. * tests/derivations.scm, tests/store.scm: Likewise. * doc/guix.texi (Derivations): Likewise.
2013-08-24doc: Mention what's in the chroot, and add a caveat about /dev/shm.Ludovic Courtès
* doc/guix.texi (Setting Up the Daemon): Document the default content of the chroot, and the /dev/shm caveat.
2013-07-17doc: Add "Adding New Packages".Ludovic Courtès
* doc/guix.texi (Adding New Packages): New section. (Packaging Guidelines): Make a subsection thereof. (From the Source Tarball to the Package): New subsection. (Contributing): Link to "Adding New Packages". (Package Modules): Link to modules in Guile's manual.
2013-07-17doc: Mark 2.0.5 as being the minimum Guile version.Ludovic Courtès
* doc/guix.texi (Requirements): Require Guile 2.0.5+. * README: Ditto.
2013-07-16doc: Refer to guix-devel@gnu.org.Ludovic Courtès
* doc/guix.texi (Contributing): Refer to guix-devel@gnu.org.
2013-07-09doc: Add "Installing Debugging Files".Ludovic Courtès
* doc/guix.texi (Installing Debugging Files): New node. (Packages with Multiple Outputs): Add cross-reference.
2013-07-08doc: Add "Packages with Multiple Outputs" section.Ludovic Courtès
* doc/guix.texi (Packages with Multiple Outputs): New node. (Invoking guix package): Refer to it.
2013-07-07doc: Move the packaging guidelines to the manual.Ludovic Courtès
* HACKING (Packaging Guidelines): Remove. * doc/guix.texi (Packaging Guidelines): New node.
2013-07-07doc: Add a "Porting" section.Ludovic Courtès
* HACKING (Porting the Guix distro on a new platform): Remove. * doc/guix.texi (Porting): New node. Describe cross-compilation as the only approach.
2013-07-07doc: Add a "Boostrapping" section.Ludovic Courtès
* doc/guix.texi (Package Modules): New node, with material formerly under "GNU Distribution". (Bootstrapping): New node. * Makefile.am (EXTRA_DIST): Add doc/images/bootstrap-graph.dot and doc/images/bootstrap-graph.eps. (infoimagedir, dist_infoimage_DATA, DOT_OPTIONS): New variable. (.dot.png, .dot.eps, doc/guix.pdf, doc/guix.info, doc/guix.ps): New targets. * doc/images/bootstrap-graph.dot: New file.
2013-06-13guix gc: Add `--requisites'.Ludovic Courtès
* guix/scripts/gc.scm (show-help, %options): Add `--requisites'. (guix-gc): Handle it. * doc/guix.texi (Invoking guix gc): Document `--requisites'. * NEWS: Update.
2013-06-04doc: Write about patch submission and packaging guidelines.Ludovic Courtès
* HACKING: Update the command names from `guix-build' to `guix build' & co. (Submitting Patches, Packaging Guidelines): New sections. * doc/guix.texi (Contributing): New section.