aboutsummaryrefslogtreecommitdiff
path: root/doc/guix.texi
Commit message (Collapse)AuthorAge
* doc: Improve debugging file documentation.Ludovic Courtès2014-05-14
| | | | | | * doc/guix.texi (Installing Debugging Files): Add @cindex. Remove unneeded '-i' in example. Mention source code an 'directory'. Link to "Build Systems" instead of "Defining Packages".
* doc: Add example for --search.Ludovic Courtès2014-05-12
| | | | * doc/guix.texi (Invoking guix package): Add LGPLv3 example.
* doc: Add a section on perl modules in the packaging guidelines.Andreas Enge2014-05-11
| | | | | * doc/guix.texi (Perl modules): New section explaining the naming of perl modules.
* doc: Mention Kiselyov's work on "staging".Ludovic Courtès2014-05-08
| | | | | * doc/guix.texi (G-Expressions): Mention Oleg's work on "staging" in footnote.
* doc: Minor improvements in "G-Expressions".Ludovic Courtès2014-05-03
| | | | | | * doc/guix.texi (G-Expressions): Show coreutils version number in store file name. Add xref to "Derivations", in documentation of 'gexp->derivation'. Fix typo.
* system: Add first-class file system declarations.Ludovic Courtès2014-05-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * gnu/system.scm (<operating-system>)[initrd]: Default to 'qemu-initrd'. (<file-system>): New record type. (operating-system-root-file-system): New procedure. (operating-system-derivation): Take the device name for GRUB from 'operating-system-root-file-system'. Pass the 'operating-system-initrd' procedure the list of boot file systems. * gnu/system/linux-initrd.scm (file-system->spec): New procedure. (qemu-initrd): Add 'file-systems' parameter, and remove #:mounts parameter. [file-system-type-predicate]: New procedure. [linux-modules]: Use it. Adjust #:mounts argument in 'boot-system' call. (gnu-system-initrd): Remove. * gnu/system/vm.scm (%linux-vm-file-systems): New variable. (expression->derivation-in-linux-vm): Adjust call to 'qemu-initrd'. (virtualized-operating-system): New procedure. (system-qemu-image/shared-store-script)[initrd]: Remove. Use 'virtualized-operating-system'. Get the 'initrd' file from OS-DRV. * guix/build/linux-initrd.scm (mount-qemu-smb-share, mount-qemu-9p): Remove. (MS_RDONLY, MS_BIND): New global variables. (bind-mount): Remove local 'MS_BIND' definition. (mount-root-file-system): New procedure, with code formerly in 'boot-system'. (mount-file-system): New procedure. (boot-system): Add #:root-fs-type parameter. Remove 'MS_RDONLY' local variable. Use 'mount-root-file-system' and 'mount-file-system'. * doc/guix.texi (Using the Configuration System): Add 'file-system' declaration.
* monads: Hide 'derivation-expression' and 'lower-inputs'.Ludovic Courtès2014-04-28
| | | | | | | | | | | | | | | | | * guix/monads.scm: Unexport 'lower-inputs' and 'derivation-expression'. (text-file*): Add comment about the switch to 'gexp->derivation'. (lower-inputs): Add comment about its doom. (derivation-expression): Likewise. * guix/gexp.scm (lower-inputs*): Rename to... (lower-inputs): ... this. Update callers. * tests/monads.scm (derivation-expression): New procedure. * doc/guix.texi (The Store Monad): Use 'gexp->derivation' instead of 'derivation-expression'. Remove documentation of 'derivation-expression'. * guix/ui.scm (read/eval): Use THE-ROOT-MODULE so that macros are properly expanded. * tests/guix-build.sh: Use 'gexp->derivation' instead of 'derivation-expression'.monads: Hide 'derivation-expression' and 'lower-inputs'.
* services: Rewrite using gexps.Ludovic Courtès2014-04-28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * gnu/services.scm (<service>)[inputs]: Remove. * gnu/system.scm (links): Remove. (etc-directory): Add PASSWD and SHADOW to #:inputs. (operating-system-boot-script): Pass ETC to 'dmd-configuration-file'. (operating-system-derivation): Remove EXTRAS from the union. * gnu/system/linux.scm (pam-service->configuration): Rewrite in terms of 'gexp->derivation'. Compute the contents on the build side. Expect 'arguments' to contain a list of gexps. (pam-services->directory): Rewrite in terms of 'gexp->derivation'. (unix-pam-service): Change 'arguments' to a list of one gexp. * gnu/system/shadow.scm (<user-account>)[inputs]: Remove. [shell]: Change default value to a gexp. (passwd-file): Rewrite in terms of 'gexp->derivation'. Compute contents on the build side. * gnu/services/base.scm (host-name-service, mingetty-service, nscd-service, syslog-service, guix-service): Change 'start' and 'stop' to gexps; remove 'inputs' field. (guix-build-accounts): Change 'shell' field to a gexp. * gnu/services/networking.scm (static-networking-service): Change 'start' and 'stop' to gexps; remove 'inputs' field. * gnu/services/xorg.scm (slim-service): Likewise. * gnu/services/dmd.scm (dmd-configuration-file): Expect ETC to be a derivation. Change 'config' to a gexp. Use 'gexp->file' instead of 'text-file'. * doc/guix.texi (Defining Services): Update nscd example with gexps, and without 'inputs'. Add xref to "G-Expressions".
* Add (guix gexp).Ludovic Courtès2014-04-28
| | | | | | | | | | | * guix/gexp.scm: New file. * tests/gexp.scm: New file. * Makefile.am (MODULES): Add guix/gexp.scm. (SCM_TESTS): Add tests/gexp.scm. * doc/guix.texi (Derivations): Add #:inputs in 'derivation' example. Mark 'build-expression->derivation' as deprecated, refer to "G-Expressions". Remove paragraph about code strata. (G-Expressions): New node.
* doc: Expect to fix typo.Alírio Eyng2014-04-09
| | | | | | * doc/guix.texi (Build Systems): "except" it is. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* guix system: Add 'vm-image' action and '--image-size' option.Ludovic Courtès2014-04-09
| | | | | | | | | * guix/scripts/system.scm (%options): Add --image-size. (%default-options): Add 'image-size'. (guix-system)[parse-options]: Handle the 'vm-image' action. Honor them. (show-help): Update accordingly. * doc/guix.texi (Invoking guix system): Add 'vm-image'.
* doc: Add "Build Systems" section.Ludovic Courtès2014-04-05
| | | | | | | | | | * doc/guix.texi (Defining Packages): Add 'arguments' field in the example; update 'synopsis' and 'description'. Remove most of the description of 'build-system', and instead reference to the "Build Systems" node. Briefly describe 'arguments' field, and remove more elaborate description. Add cross-reference to "Packaging Guidelines". (Build Systems): New node. (Packaging Guidelines): Mention '--log-file'.
* doc: Update description of the chroot contents.Ludovic Courtès2014-04-03
| | | | | * doc/guix.texi (Build Environment Setup): Adjust description of /dev and /proc; remove footnote about /dev/shm, now obsolete.
* doc: fix typo.Alex Sassmannshausen2014-03-31
| | | | | | * doc/guix.texi (Substitutes): add a missing 's'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Document substitutes.Ludovic Courtès2014-03-30
| | | | | | | | | | * doc/guix.texi (Invoking guix-daemon): Add cross-reference to "Substitutes". (Features): Remove footnote about unauthenticated substitutes. Link to "Substitutes". (Substitutes): New node. (Invoking guix build): Link to "Substitutes". (Packaging Guidelines): Likewise.
* offload: Allow build machines to specify a port number.Ludovic Courtès2014-03-13
| | | | | * guix/scripts/offload.scm (<build-machine>): Add 'port' field. (remote-pipe, send-files): Use lsh's '-p' option when invoking it.
* guix build: Add '--with-source'.Ludovic Courtès2014-03-12
| | | | | | | | | | * guix/scripts/build.scm (package-with-source): New procedure. (show-help): Add '--with-source'. (%options): Likewise. (options->derivations): Call 'options/with-source' and 'options/resolve-packages'. (options/resolve-packages, options/with-source): New procedures. * doc/guix.texi (Invoking guix build): Document '--with-source'.
* doc: Update packaging guidelines.Pierre-Antoine Rault2014-03-10
| | | | | | | | | * HACKING (Submitting Patches): Mention 'git send-mail'. * doc/guix.texi (Packaging Guidelines): More details on how to prepare a package module. (Contributing): Add reference to #guix channel on Freenode. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* guix build: Add '--timeout' to the common build options.Ludovic Courtès2014-03-09
| | | | | | | | | * guix/scripts/build.scm (show-build-options-help): Document '--timeout'. (set-build-options-from-command-line): Pass #:timeout to 'set-build-options'. (%standard-build-options): Add '--timeout'. * doc/guix.texi (Invoking guix build): Document it.
* Change the default store file name to /gnu/store.Ludovic Courtès2014-03-09
| | | | | | | | * configure.ac: Change the default 'storedir' to /gnu/store. Print $storedir. * doc/guix.texi: Replace "/nix/store" by "/gnu/store", except where describing Nix compatibility. * Makefile.am: Likewise.
* doc: Explain what's special about the (gnu packages ...) name space.Ludovic Courtès2014-03-08
| | | | | | | | | | * doc/guix.texi (Invoking guix package): Explain where packages are searched for and link to "Package Modules". (Defining Packages) <example>: Use 'define-module' clause instead of 'use-modules'. Explain why and link to "Package Modules". (Invoking guix build): Explain where packages aer searched for and link to "Package Modules". (Package Modules): Explain that (gnu packages ...) is scanned.
* doc: Factorize documentation of common build options.Ludovic Courtès2014-03-03
| | | | | | | | | | * doc/guix.texi (Invoking guix package): Remove documentation for --dry-run, --fallback, --no-substitutes, and --max-silent-time. Add a cross-ref to "Invoking guix build". (Invoking guix archive): Add "common build options" as the cross-ref topic for "Invoking guix build". (Invoking guix build): Move common build options separately. Add a paragraph to explain.
* derivations: Remove unused 'derivation' parameter.Ludovic Courtès2014-02-21
| | | | | * guix/derivations.scm (derivation): Remove unused #:hash-mode parameter. * doc/guix.texi (Derivations): Adjust accordingly.
* doc: More on what's special about the archive format.Ludovic Courtès2014-02-21
| | | | | * doc/guix.texi (Invoking guix archive): Expound on what sets the Nar format apart.
* derivations: Add support for recursive fixed-output derivations.Ludovic Courtès2014-02-21
| | | | | | | | | | | | | | | | | | | | | * guix/derivations.scm (<derivation-output>): Add 'recursive?' field. Adjust 'make-derivation-output' callers. (%read-derivation) <fixed-output>: When HASH-ALGO starts with 'r:', set the 'recursive?' field and drop 'r:' from the hash algo name. (write-derivation)[write-output]: Write the algo as 'r:HASH-ALGO' when the RECURSIVE? field is set. (derivation-hash) <fixed-output>: Prepend "r:" when RECURSIVE? is set. (fixed-output-path): New procedure. (derivation): Add #:recursive? parameter. Use 'fixed-output-path' to compute the output file name of a fixed output derivation. (build-expression->derivation): Add #:recursive? parameter. Pass it to 'derivation'. * tests/derivations.scm ("fixed-output derivation, recursive", "build-expression->derivation produces recursive fixed-output", "build-expression->derivation uses recursive fixed-output"): New tests. * doc/guix.texi (Derivations): Document #:recursive? for 'derivation'. Add #:recursive? for 'build-expression->derivation'.
* guix hash: Add '--recursive'.Ludovic Courtès2014-02-21
| | | | | | | | | | | | * guix/scripts/hash.scm (show-help): Add --recursive. (%options): Likewise. (guix-hash)[file-hash]: New procedure. Honor --recursive. Use it. * guix/nar.scm (write-file): Add missing field to the &nar-error condition raised upon unsupported file type; change its message to be more descriptive. * tests/guix-hash.sh: Add tests with -r. * doc/guix.texi (Invoking guix hash): Document --recursive.
* gnu: Define '%base-services'.Ludovic Courtès2014-02-19
| | | | | | | | * gnu/services/base.scm (%base-services): New variable. * gnu/system.scm (<operating-system>)[services]: Change the default value to %BASE-SERVICES. * doc/guix.texi (Using the Configuration System): Change '%standard-services' to '%base-services'.
* gnu: Introduce the (gnu services ...) modules.Ludovic Courtès2014-02-19
| | | | | | | | | | | * gnu/system/dmd.scm: Remove file. Move contents to... * gnu/services.scm, gnu/services/base.scm, gnu/services/dmd.scm, gnu/services/networking.scm, gnu/services/xorg.scm: ... here. New files. * gnu/system.scm, gnu/system/vm.scm: Adjust accordingly. * guix/scripts/system.scm (%user-module): Likewise. * doc/guix.texi (Using the Configuration System): Likewise. (Defining Services): Likewise.
* Add 'guix system'.Ludovic Courtès2014-02-18
| | | | | | | | | * guix/scripts/system.scm: New file. * Makefile.am (MODULES): Add it. * po/POTFILES.in: Likewise. * doc/guix.texi (Using the Configuration System): Link to "Invoking guix system". (Invoking guix system): New node.
* daemon: Add '--gc-keep-outputs' and '--gc-keep-derivations'.Ludovic Courtès2014-02-06
| | | | | | | | | | | * nix/nix-daemon/guix-daemon.cc (GUIX_OPT_GC_KEEP_OUTPUTS, GUIX_OPT_GC_KEEP_DERIVATIONS): New macros. (options): Add 'gc-keep-outputs' and 'gc-keep-derivations'. (string_to_bool): New function. (parse_opt): Honor GUIX_OPT_GC_KEEP_DERIVATIONS and GUIX_OPT_GC_KEEP_OUTPUTS. * doc/guix.texi (Invoking guix-daemon): Document --gc-keep-outputs and --gc-keep-derivations.
* monads: Add 'text-file*'.Ludovic Courtès2014-02-03
| | | | | | | | * guix/monads.scm (text-file*): New procedure. * tests/monads.scm ("text-file*"): New test. * doc/guix.texi (The Store Monad): Change example since the previous one would erroneously fail to retain a reference to Coreutils. Document 'text-file*'.
* derivations: Add #:local-build? parameter for derivations.Ludovic Courtès2014-01-25
| | | | | | | | * guix/derivations.scm (derivation): Add #:local-build? parameter and honor it. (build-expression->derivation): Likewise. * doc/guix.texi (Derivations): Update documentation of these procedures.
* doc: More about offloading.Ludovic Courtès2014-01-25
| | | | | | | * doc/guix.texi (Daemon Offload Setup): Start with "When desired". Say more on what can go in 'machines.scm', and mention Guile-Avahi. (Invoking guix-daemon): Document '--no-build-hook'. (Invoking guix build): Add xref to "Daemon Offload Setup".
* Add 'guix offload' as a daemon build hook.Ludovic Courtès2014-01-24
| | | | | | | | | | | | | | | | | | | | | | | | * nix/nix-daemon/guix-daemon.cc (GUIX_OPT_NO_BUILD_HOOK): New macro. (options): Add '--no-build-hook'. (parse_opt): Handle it. (main)[HAVE_DAEMON_OFFLOAD_HOOK]: Set 'useBuildHook' by default. Set $NIX_BUILD_HOOK to our offload hook unless otherwise specified. [!HAVE_DAEMON_OFFLOAD_HOOK]: Clear 'useBuildHook'. * pre-inst-env.in: Set and export NIX_BUILD_HOOK. * nix/scripts/offload.in, guix/scripts/offload.scm: New files. * guix/ui.scm (show-guix-help)[internal?]: Add "offload". * config-daemon.ac: Call 'GUIX_CHECK_UNBUFFERED_CBIP'. Instantiate 'nix/scripts/offload'. Set 'BUILD_DAEMON_OFFLOAD' conditional, and optionally define 'HAVE_DEAMON_OFFLOAD_HOOK' cpp macro. * daemon.am (nodist_pkglibexec_SCRIPTS)[BUILD_DAEMON_OFFLOAD]: Add it. * Makefile.am (MODULES)[BUILD_DAEMON_OFFLOAD]: Add 'guix/scripts/offload.scm'. (EXTRA_DIST)[!BUILD_DAEMON_OFFLOAD]: Likewise. * m4/guix.m4 (GUIX_CHECK_UNBUFFERED_CBIP): New macro. * doc/guix.texi (Setting Up the Daemon): Move most of the body to... (Build Environment Setup): ... this. New subsection. (Daemon Offload Setup): New subsection.
* doc: List what's in the chroot.Ludovic Courtès2014-01-18
| | | | * doc/guix.texi (Setting Up the Daemon): List what's in the chroot.
* Update 'nix-upstream' sub-module; adjust build system, doc, and substituter.Ludovic Courtès2014-01-18
| | | | | | | | | | | | | * nix-upstream: Update sub-module. * daemon.am (libutil_a_SOURCES): Add affinity.cc. (libutil_headers): Add affinity.hh. (libexec_PROGRAMS, nix_setuid_helper_SOURCES, nix_setuid_helper_CPPFLAGS, nix_setuid_helper_LDADD): Remove. * doc/guix.texi (Setting Up the Daemon): Remove paragraph about 'nix-setuid-helper'. * guix/scripts/substitute-binary.scm (guix-substitute-binary): Exit 0 when %CACHE-URL has an HTTP scheme and looking up its host fails. Always print a newline to stdout when starting.
* doc: Distinguish between (gnu packages ...) and "GNU packages".Ludovic Courtès2014-01-17
| | | | | * doc/guix.texi (Package Modules): Add a footnote stating that (gnu packages ...) has nothing to do with "GNU packages."
* doc: Fix another reference to (gnu packages admin).Ludovic Courtès2014-01-14
| | | | | * doc/guix.texi (Using the Configuration System): Change module name to (gnu packages admin).
* archive: Add '--missing'.Ludovic Courtès2014-01-06
| | | | | | | | * guix/scripts/archive.scm (show-help, %options): Add '--missing'. (guix-archive)[lines]: New procedure. Use it to honor '--missing'. * tests/guix-archive.sh: Add tests. * doc/guix.texi (Invoking guix archive): Document '--missing'.
* guix build: Add '--no-build-hook'.Ludovic Courtès2014-01-05
| | | | | | | * guix/scripts/build.scm (%default-options): Add 'build-hook?' pair. (show-help, %options): Add --no-build-hook. (guix-build): Pass the 'build-hook?' value to 'set-build-options'. * doc/guix.texi (Invoking guix build): Document '--no-build-hook'.
* archive: Add '--authorize'.Ludovic Courtès2013-12-30
| | | | | | | | | * guix/scripts/archive.scm (authorize-key): New procedure. (guix-archive): Call it when OPTS contains 'authorize-key'. * tests/guix-archive.sh: Add test with invalid public key. * guix/pki.scm: Export '%acl-file'. * doc/guix.texi (Invoking guix archive): Make it clear that '--import' works only with authorized keys. Document '--authorize'.
* archive: Add '--generate-key'.Ludovic Courtès2013-12-30
| | | | | | | | | | | | * guix/pk-crypto.scm (error-source, error-string): New procedures. * guix/pki.scm (%private-key-file): New variable. * guix/scripts/archive.scm (show-help): Document '--generate-key'. (%options): Add "generate-key". (generate-key-pair): New procedure. (guix-archive): Call 'generate-key' when OPTS contains a 'generate-key' pair. * doc/guix.texi (Setting Up the Daemon): Suggest generating a key pair. (Invoking guix archive): Document '--generate-key'.
* doc: Invoke 'useradd' with '--system'.Ludovic Courtès2013-12-30
| | | | | | | | Reported by Kete <kete@ninthfloor.org>. Fixes <http://bugs.gnu.org/16289>. * doc/guix.texi (Setting Up the Daemon): Add '--system' to the 'useradd' command line. Suggested by Kete <kete@ninthfloor.org>.
* Add 'guix archive'.Ludovic Courtès2013-12-22
| | | | | | | | | * guix/scripts/archive.scm, tests/guix-archive.sh: New files. * Makefile.am (MODULES): Add 'archive.scm'. (SH_TESTS): Add 'guix-archive.sh'. * doc/guix.texi (Invoking guix archive): New section. * guix/scripts/build.scm: Export 'derivation-from-expression'. * guix/scripts/package.scm: Export 'specification->package+output'.
* guix package: allow multiple arguments after -i, -r, and -u.Mark H Weaver2013-12-14
| | | | | | | | | | | | | | | | * 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.
* doc: Slightly improve the "System Configuration" node.Ludovic Courtès2013-12-11
| | | | | | | * 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".
* doc: First stab at documenting whole-system configuration.Ludovic Courtès2013-12-10
| | | | | | | * doc/guix.texi (Features): Add xref to "Using the Configuration System". (System Configuration, Using the Configuration System, Defining Services): New nodes.
* derivations: Use more keyword parameters for 'build-expression->derivation'.Ludovic Courtès2013-12-04
| | | | | | | | | | | | | | | | | * 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'.
* doc: List the supported platforms.Ludovic Courtès2013-11-23
| | | | * doc/guix.texi (GNU Distribution): List the supported platforms.
* doc: Link to package-list.html.Ludovic Courtès2013-11-19
| | | | * doc/guix.texi (GNU Distribution): Add link to package-list.html.
generated by cgit v1.2.3 (git 2.45.0) at 2024-12-30 17:55:30 +0000