aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* doc: Remove redundant listing of services.Ludovic Courtès2014-07-14
| | | | | * doc/guix.texi (Defining Services): Remove listing of service procedures; add xref to "Services".
* services: Add options to 'guix-service'.Ludovic Courtès2014-07-14
| | | | | | * gnu/services/base.scm (guix-service): Add #:use-substitutes? and #:extra-options parameters, and honor them. * doc/guix.texi (Base Services): Adjust accordingly.
* services: Add Tor service.Ludovic Courtès2014-07-12
| | | | | | | * gnu/services/networking.scm (tor-service): New procedure. * doc/guix.texi (Networking Services): Document it. * build-aux/hydra/demo-os.scm: Use it. Add TOR and TORSOCKS to 'packages'.
* doc: Start writing about services.Ludovic Courtès2014-07-11
| | | | | | | * doc/guix.texi (Using the Configuration System): Remove details about '%base-services', and link to "Services". (Services): Add introductory text. (Base Services, Networking Services, X Window): New nodes.
* guix system: Add '--system' option.Ludovic Courtès2014-07-08
| | | | | | | | | | * guix/scripts/system.scm (switch-to-system): Add #:system parameter; pass it to 'run-with-store'. (%options): Add '--system'. (guix-system): Pass the 'system' option to 'run-with-store', 'package-derivation', and 'switch-to-system' calls. * doc/guix.texi (Invoking guix system): Document '--system' and '--image-size'.
* doc: Document user accounts and user groups.Ludovic Courtès2014-07-03
| | | | | * doc/guix.texi (File Systems): Fix typo. (User Accounts): Populate.
* doc: Write about file system configuration.Ludovic Courtès2014-07-02
| | | | | | * doc/guix.texi (Using the Configuration System): Change 'guix system boot' to 'guix system reconfigure'. (File Systems, User Accounts, Services): New nodes.
* doc: Improve wording and example in "Using the Configuration System".Ludovic Courtès2014-06-27
| | | | | | * doc/guix.texi (Using the Configuration System): Make the intro more user-oriented. Change example to return an operating system. Fix typos. Mention mandatory/optional fields.
* guix system: Add 'reconfigure' action.Ludovic Courtès2014-06-27
| | | | | | | | | | * guix/scripts/system.scm (%system-profile): New variable. (switch-to-system, previous-grub-entries): New procedures. (unless-file-not-found): New macro. (show-help): Add 'reconfigure'. (guix-system): Handle it. * gnu/system.scm: Export 'operating-system-activation-script'. * doc/guix.texi (Invoking guix system): Document it.
* doc: Mention KVM support for 'guix system'.Ludovic Courtès2014-06-19
| | | | * doc/guix.texi (Invoking guix system): Add note about KVM support.
* guix build: Allow gexps to be passed to '-e'.Ludovic Courtès2014-06-14
| | | | | | | | | | | | | | | | | * guix/ui.scm (%guix-user-module): New variable. (read/eval): Pass it as the second argument to 'eval'. * guix/scripts/build.scm (options/resolve-packages): Add case for 'gexp?'. * tests/guix-build.sh: Add tests. * doc/guix.texi (Invoking guix build): Document '-e gexp'. guxi build: Allow gexps to be passed to '-e'. * guix/ui.scm (%guix-user-module): New variable. (read/eval): Pass it as the second argument to 'eval'. * guix/scripts/build.scm (options/resolve-packages): Add case for 'gexp?'. * tests/guix-build.sh: Add tests. * doc/guix.texi (Invoking guix build): Document '-e gexp'.
* doc: Add a few words on the term "derivation".Ludovic Courtès2014-06-09
| | | | * doc/guix.texi (Programming Interface): Add a sentence on "derivation".
* derivations: 'build-expression->derivation' supports #:allowed-references.Ludovic Courtès2014-06-06
| | | | | | * guix/derivations.scm (build-expression->derivation): Add #:allowed-references and pass it to 'derivation. * doc/guix.texi (Derivations): Adjust accordingly.
* system: Define '%base-packages' and use it.Ludovic Courtès2014-06-04
| | | | | | | | | | * gnu/system.scm (<operating-system>)[packages]: Change default value to %BASE-PACKAGES. (%base-packages): New variable. * gnu/system/install.scm (installation-os): Use it when defining the 'packages' field. * doc/guix.texi (Using the Configuration System): Use %BASE-PACKAGES in example. Remove now unneeded module imports. Explain this.
* derivations: Add #:allowed-references 'derivation' parameter.Ludovic Courtès2014-06-01
| | | | | | | | | | | * guix/derivations.scm (derivation): Add #:allowed-references parameter. [user+system-env-vars]: Honor it. * tests/derivations.scm ("derivation #:allowed-references, ok", "derivation #:allowed-references, not allowed", "derivation #:allowed-references, self allowed", "derivation #:allowed-references, self not allowed"): New tests. * doc/guix.texi (Derivations): Document #:allowed-references.
* linux-initrd: Allow use of volume labels in 'file-system' declarations.Ludovic Courtès2014-05-30
| | | | | | | | | | | | | | * guix/build/linux-initrd.scm (%ext2-endianness, %ext2-sblock-magic, %ext2-sblock-creator-os, %ext2-sblock-uuid, %ext2-sblock-volume-name): New macros. (read-ext2-superblock, ext2-superblock-uuid, ext2-superblock-volume-name, disk-partitions, partition-label-predicate, find-partition-by-label, canonicalize-device-spec): New procedures. (mount-file-system): Use 'canonicalize-device-spec' on SOURCE. (boot-system): Likewise for ROOT. * doc/guix.texi (Using the Configuration System): Adjust 'file-system' declaration accordingly.
* doc: Augment "Package Naming".Ludovic Courtès2014-05-25
| | | | | * doc/guix.texi (Package Naming): Mention underscores, and give SDL_net as an example.
* services: nscd: Provide an 'activate' script to make /var/run/nscd.Ludovic Courtès2014-05-24
| | | | | | | | * gnu/services/base.scm (nscd-service): Add 'activate' field. * guix/build/install.scm (directives): Remove /var/run/nscd; add /var/run. * doc/guix.texi (Defining Services): Add 'activate' field in example. Document it.
* guix system: Add 'disk-image' action.Ludovic Courtès2014-05-22
| | | | | | | | * guix/scripts/system.scm (show-help): Add 'disk-image'. (guix-system)[parse-options]: Support 'disk-image' action. [option-arguments]: Likewise. Handle the 'disk-image' action. * doc/guix.texi (Invoking guix system): Document 'disk-image'.
* Add (gnu) module.Ludovic Courtès2014-05-22
| | | | | | | | | * gnu.scm: New file. * gnu-system.am (GNU_SYSTEM_MODULES): Add it. * build-aux/hydra/demo-os.scm: Use (gnu) and strip import list accordingly. * doc/guix.texi (Using the Configuration System): Adjust example accordingly.
* doc: Show the 'bootloader' field in system example.Ludovic Courtès2014-05-19
| | | | | * doc/guix.texi (Using the Configuration System): Add 'bootloader' field.
* guix system: 'guix system init' installs GRUB by default.Ludovic Courtès2014-05-19
| | | | | | | | | | | * guix/scripts/system.scm (install): Add #:grub?, #:grub.cfg, and #:device parameters; honor them. (show-help): Document '--no-grub'. (%options): Add '--no-grub'. (%default-options): Add 'install-grub?'. (guix-system): Honor 'install-grub?' option from OPTS. Adjust 'install' call accordingly. * doc/guix.texi (Invoking guix system): Document '--no-grub'.
* guix system: Add 'init' sub-command.Ludovic Courtès2014-05-18
| | | | | | | | | * guix/scripts/system.scm (install): New procedure. (guix-system)[parse-option]: Remove check for extraneous arguments. [match-pair, option-arguments]: New procedures. Use 'option-arguments'. Honor 'init'. (show-help): Document 'init'. * doc/guix.texi (Invoking guix system): Document 'init'.
* guix system: Add 'build' action.Ludovic Courtès2014-05-16
| | | | | | * guix/scripts/system.scm (show-help): Document 'build' action. (guix-system): Honor 'build' action. * doc/guix.texi (Invoking guix system): Add 'build' action.
* 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.