summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2019-03-04environment: Rename '--inherit' to '--preserve'.Ludovic Courtès
Suggested by Eric Bavier and Ricardo Wurmus. * guix/scripts/environment.scm (show-help, %options): Emit a deprecation warning for "--inherit" and add -E/--preserve. * tests/guix-environment.sh: Adjust accordingly. * doc/guix.texi (Invoking guix environment): Update accordingly.
2019-03-04doc: Better explain the 'password' field of <user-account>.Ludovic Courtès
* doc/guix.texi (User Accounts): Provide an example use of 'crypt', and mention the security implications.
2019-03-01nls: Update 'fr' translation of the manual.Julien Lepiller
2019-02-19doc: Fix typo.Tobias Geerinckx-Rice
* doc/guix.texi (Proceeding with the Installation): Fix typo.
2019-02-17services: xorg: Enable override of xserver-arguments.Jan Nieuwenhuizen
* gnu/services/xorg.scm (xorg-start-command): Add parameter #:xserver-arguments. * doc/guix.texi (X Window): Document it.
2019-02-17doc: '--inherit' option can be repeated.Ludovic Courtès
* doc/guix.texi (Invoking guix environment): Mention that '--inherit' can be repeated.
2019-02-16services: Improve the upower-service-type.Christopher Baines
Add a description and default value. Switch the documentation to mention the service-type and the configuration record, rather than the upower-service procedure. * gnu/services/desktop.scm (upower-service-type)[description, default-value]: Define these fields. (%desktop-services): Change (upower-service) to (service upower-service-type). * doc/guix.texi (Desktop Services): Update the upower service documentation.
2019-02-16environment: Add '--inherit'.Ludovic Courtès
* guix/scripts/environment.scm (purify-environment): Add 'white-list' parameter and honor it. (create-environment): Add #:white-list parameter and honor it. (launch-environment): Likewise. (launch-environment/fork): Likewise. (show-help, %options): Add '--inherit'. (guix-environment): Define 'white-list' and pass it to 'launch-environment/fork'. * tests/guix-environment.sh: Test '--inherit'. * doc/guix.texi (Invoking guix environment): Document it.
2019-02-13doc: Add a "Development" chapter.Ludovic Courtès
* doc/guix.texi (Managing Software the Guix Way): Add reference to the "Development" section. (Invoking guix environment, Invoking guix pack): Move to... (Development): ... here. New node.
2019-02-13guix system: Add 'delete-generations'.Ludovic Courtès
* guix/scripts/package.scm (delete-matching-generations): Export. * guix/scripts/system.scm (show-help): Add 'delete-generations'. (process-command): Honor it. (guix-system): Support it. * doc/guix.texi (Invoking guix system): Document it.
2019-02-12doc: Clarify channel file structure.Chris Marusich
Suggested by Hartmut Goebel <h.goebel@crazy-compilers.com>. * doc/guix.texi (Channels): Clarify how a channel author should structure the files in their channel's Git repository.
2019-02-09Merge branch 'staging'Ludovic Courtès
2019-02-08guix build: '--with-branch' & co. fetch submodules.Ludovic Courtès
* guix/scripts/build.scm (transform-package-source-branch)[replace]: Add 'recursive?' field to the new package.
2019-02-07doc: Mention flag to get an ISO image.Ludovic Courtès
* doc/guix.texi (Building the Installation Image): Add '--file-system-type=iso9660'.
2019-02-04doc: Document how to enable qemu binfmt service and how to use it.Danny Milosavljevic
* doc/contributing.texi (Submitting Patches): Document how to enable qemu binfmt service and how to use it. Co-authored-by: Ricardo Wurmus <rekado@elephly.net>
2019-02-04doc: Show how to install Emacs, Guile, and Geiser.Ludovic Courtès
* doc/contributing.texi (The Perfect Setup): Show "guix package -i" command line.
2019-02-01doc: Update left-over references to lsh.Tobias Geerinckx-Rice
* doc/guix.texi (Using the Configuration System, Defining Services): Refer to OpenSSH instead of lsh.
2019-01-31Merge branch 'master' into stagingMarius Bakke
2019-01-28doc: Clarify 'sudo' vs. 'guix pull' and 'guix system reconfigure'.Ludovic Courtès
* doc/guix.texi (Proceeding with the Installation): Clarify use of "sudo" with "guix pull" and "guix system reconfigure".
2019-01-26doc: Update bit about GUIX_LD_WRAPPER_ALLOW_IMPURITIES.Ludovic Courtès
This is a followup to d0a2db47fb550d684c47a0ae3b541a9a71727d9e. * doc/guix.texi (Application Setup)[The GCC toolchain]: Adjust bit about GUIX_LD_WRAPPER_ALLOW_IMPURITIES.
2019-01-26doc: Switch from "GuixSD" to "Guix System".Ludovic Courtès
* doc/guix.texi (Introduction): Add footnote about the change from "GuixSD" to "Guix System". Replace occurrences of "GuixSD" with "Guix System", "Guix", "system", or other appropriate phrases.
2019-01-26doc: Make /dev/kvm note more visible.Ludovic Courtès
Suggested by Giovanni Biscuolo <g@xelera.eu>. * doc/guix.texi (Invoking guix system): Move note about /dev/kvm access to the beginning of the 'vm' action description.
2019-01-25Merge branch 'master' into stagingRicardo Wurmus
2019-01-25weather: Add '--coverage'.Ludovic Courtès
* guix/scripts/weather.scm (show-help, %options): Add '--coverage'. (package-partition-boundary, package->output-mapping) (substitute-oracle, report-package-coverage-per-system) (report-package-coverage): New procedures. (guix-weather): Honor '--coverage'. * doc/guix.texi (Invoking guix weather): Document it.
2019-01-23doc: Replace some cons* with beginner-friendly (append (list ...)).Pierre Neidhardt
* doc/guix.texi (Base Services): Do it.
2019-01-23doc: Correct EFI-specific system configuration details.Pierre Neidhardt
* doc/guix.texi (Preparing for Installation): /boot/efi is arbitrary. Mention /boot/efi consistently. (Proceeding with the Installation): Make it explicit that the EFI mount point must both be mounted and be specified in the system configuration.
2019-01-23Merge branch 'master' into stagingRicardo Wurmus
2019-01-22doc: Move "Package Modules" under "Programming Interface".Ludovic Courtès
* doc/guix.texi (Package Modules): Move to... (Programming Interface): ... here. Turn into a section.
2019-01-22doc: Move "Packaging Guidelines" under "Contributing".Ludovic Courtès
* doc/guix.texi (Packaging Guidelines): Move to... * doc/contributing.texi (Packaging Guidelines): ... here. Turn into a section. Adjust references to "Contributing".
2019-01-22doc: Move "System Installation" right after "Installation".Ludovic Courtès
* doc/guix.texi (System Installation): Move right after "Installation".
2019-01-22doc: Move sections under "GNU Distribution" one level higher.Ludovic Courtès
* doc/guix.texi (Introduction): Add note about Guix System. [Managing Software the Guix Way]: New section heading. [GNU Distribution]: New subsection of "Introduction". Mention "Guix System" rather than "GuixSD" and update the list of supported systems. (GNU Distribution): Remove as a chapter. (System Installation, System Configuration, Documentation) (Installing Debugging Files, Security Updates, Package Modules) (Packaging Guidelines, Bootstrapping, Porting): Turn these sections into chapters.
2019-01-21store: Rename '&nix-error' to '&store-error'.Ludovic Courtès
* guix/store.scm (&nix-error): Rename to... (&store-error): ... this, and adjust users. (&nix-connection-error): Rename to... (&store-connection-error): ... this, and adjust users. (&nix-protocol-error): Rename to... (&store-protocol-error): ... this, adjust users. (&nix-error, &nix-connection-error, &nix-protocol-error): Define these condition types and their getters as deprecrated aliases. * build-aux/run-system-tests.scm, guix/derivations.scm, guix/grafts.scm, guix/scripts/challenge.scm, guix/scripts/graph.scm, guix/scripts/lint.scm, guix/scripts/offload.scm, guix/serialization.scm, guix/ssh.scm, guix/tests.scm, guix/ui.scm, tests/derivations.scm, tests/gexp.scm, tests/guix-daemon.sh, tests/packages.scm, tests/store.scm, doc/guix.texi: Adjust to use the new names.
2019-01-20Merge branch 'master' into stagingLudovic Courtès
2019-01-17services: openssh: Add escape hatch.Ricardo Wurmus
* gnu/services/ssh.scm (<openssh-configuration>)[extra-content]: New field. * doc/guix.texi (Networking Services): Document it.
2019-01-17doc: Document the graphical installer.Mathieu Othacehe
* doc/guix.texi (Preparing for Installation): Mention the graphical installer.
2019-01-16doc: Add missing parameter to guix system reconfigureDamien Cassou
* doc/guix.texi (Proceeding with the Installation): Mention that /etc/config.scm must be passed as parameter and that root is needed. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2019-01-16services: avahi: Deprecate the 'avahi-service' procedure.Ludovic Courtès
* gnu/services/avahi.scm (<avahi-configuration>): Export getters. Add default values. (avahi-service-type)[default-value]: New field. (avahi-service): Mark as deprecated. * gnu/services/desktop.scm (%desktop-services): Use the 'service' form instead of calling 'avahi-service'. * gnu/tests/base.scm (%avahi-os): Likewise. * doc/guix.texi (Base Services): Adjust example accordingly. (Networking Services): Update accordingly.
2019-01-13Merge branch 'master' into stagingMarius Bakke
2019-01-11guix build: Re-purpose '--verbosity' and add '--debug'.Ludovic Courtès
The previous '--verbosity' option was misleading and rarely what users were looking for. The new option provides a consistent way to choose whether or not to display the build log. * guix/scripts/build.scm (show-build-options-help): Remove "--verbosity" and add "--debug". (set-build-options-from-command-line): Use the 'debug key of OPTS for #:verbosity. (%standard-build-options): Change "verbosity" to "debug". Use 'string->number*' instead of 'string->number'. (%default-options): Change 'verbosity to 'debug and add a 'verbosity key. (show-help): Add '--verbosity'. (%options): Likewise, and change '--quiet' to set the 'verbosity key of RESULT. (guix-build): Use 'with-status-verbosity' instead of parameterizing CURRENT-BUILD-OUTPUT-PORT, honor the 'verbosity key of OPTS, and remove 'quiet?'. * guix/scripts/environment.scm (show-help, %options): Add '--verbosity'. (%default-options): Add 'debug'. (guix-environment): Honor the 'verbosity key of OPTS. * guix/scripts/pack.scm (%default-options): Add 'debug. (%options, show-help): Add '--verbosity'. (guix-pack): Honor the 'verbosity key of OPTS. * guix/scripts/package.scm (%default-options): Add 'debug. (show-help, %options): Add '--verbosity'. Mark '--verbose' as deprecated and change it to set 'verbosity. (guix-package): Honor the 'verbosity key of OPTS and remove 'verbose?'. * guix/scripts/pull.scm (%default-options): Add 'debug. (show-help, %options): Add '--verbosity'. (guix-pull): Honor the 'verbosity key of OPTS. * guix/scripts/system.scm (show-help, %options): Add '--verbosity'. (%default-options): Add 'debug. (guix-system): Honor the 'verbosity key of OPTS. * guix/scripts/archive.scm (%default-options): Add 'debug, 'print-build-trace?, 'print-extended-build-trace?, and 'multiplexed-build-output?. (show-help, %options): Add '--verbosity'. (export-from-store): Remove call to 'set-build-options-from-command-line'. (guix-archive): Wrap body in 'with-status-verbosity'. Add call to 'set-build-options-from-command-line. * doc/guix.texi (Common Build Options): Document '--verbosity' and '--debug'. (Additional Build Options): Adjust description of '--quiet'.
2019-01-11services: Deprecate a few more service procedures.Ludovic Courtès
These procedures were already either undocumented (and de facto deprecated) or documented as deprecated or redundant. * gnu/services/base.scm (guix-service, guix-publish-service): Mark as deprecated. * gnu/services/mcron.scm (mcron-service): Likewise. * gnu/services/networking.scm (tor-service): Likewise. * doc/guix.texi (Scheduled Job Execution): Remove 'mcron-service' and adjust example. (Networking Services): Remove 'tor-service'. * gnu/tests/base.scm (%mcron-os): Use 'mcron-service-type' instead of 'mcron-service'. * gnu/tests/networking.scm (%tor-os): Use 'tor-service-type' instead of 'tor-service'. * tests/guix-system.sh: Likewise.
2019-01-10services: Add docker.Danny Milosavljevic
* gnu/services/docker.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Miscellaneous Services): Document the service.
2019-01-09build: Require Guile 2.2.Ludovic Courtès
* configure.ac: Require Guile 2.2. * README: Adjust accordingly. * doc/guix.texi (Requirements): Likewise. * gnu/packages/package-management.scm (guile2.0-guix): Deprecate. (guix-minimal): Inherit from GUIX, not from GUILE2.0-GUIX.
2019-01-09Merge remote-tracking branch 'origin/master' into stagingEfraim Flashner
2019-01-08doc: Recommend using the installer script.Ricardo Wurmus
* doc/guix.texi (Installation): Make it clear that the installer script is the recommended, easy way to install Guix.
2018-12-27Merge branch 'master' into stagingMarius Bakke
2018-12-27lint: Check for unstable tarballs.Efraim Flashner
* guix/scripts/lint.scm (check-source-unstable-tarball): New procedure. (%checkers): Add it. * tests/lint.scm ("source-unstable-tarball", "source-unstable-tarball: source #f", "source-unstable-tarball: valid", "source-unstable-tarball: package named archive", "source-unstable-tarball: not-github", "source-unstable-tarball: git-fetch"): New tests. * doc/guix.texi (Invoking guix lint): Document it.
2018-12-27pull: Add '--system'.Ludovic Courtès
* guix/scripts/pull.scm (%options): Add '--system'. (guix-pull): Honor it. * doc/guix.texi (Invoking guix pull): Document it.
2018-12-26Merge branch 'master' into stagingMarius Bakke
2018-12-24offload: Use (guix inferior) instead of (ssh dist node).Ludovic Courtès
Using inferiors and thus 'guix repl' simplifies setup on build machines (no need to worry about GUILE_LOAD_PATH etc.) Furthermore, the 'guix repl -t machine' protocol running in a remote pipe addresses several issues with the current implementation of nodes and RREPLs in Guile-SSH: fewer round trips, doesn't leave a 'guile --listen' process behind it, stateless (since a new process is started each time), more efficient (the SSH channel can be reused), more reliable (no 'pgrep', 'pkill', and shellology; see <https://github.com/artyom-poptsov/guile-ssh/issues/11> as an example.) * guix/ssh.scm (inferior-remote-eval): New procedure. (send-files): Use it instead of 'make-node' and 'node-eval'. * guix/scripts/offload.scm (node-guile-version): New procedure. (node-free-disk-space, transfer-and-offload, node-load) (choose-build-machine, assert-node-has-guix): Use 'remote-inferior' instead of 'make-node' and 'inferior-eval' instead of 'node-eval'. (assert-node-can-import, assert-node-can-export): Likewise, and add 'session' parameter. (check-machine-availability): Likewise, and add calls to 'close-inferior' and 'disconnect!'. (check-machine-status): Likewise. * doc/guix.texi (Daemon Offload Setup): Remove bit related to 'guile' in $PATH and $GUILE_LOAD_PATH; mention 'guix' alone.
2018-12-24doc: Fix typo.Efraim Flashner
This is a follow-up to c39491829a0c1d870f8133b8f7a699152fc71503 * doc/guix.texi (Invoking guix refresh): Fix texinfo markup