aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* doc: Document how to enable qemu binfmt service and how to use it.Danny Milosavljevic2019-02-04
| | | | | | | * 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>
* doc: Show how to install Emacs, Guile, and Geiser.Ludovic Courtès2019-02-04
| | | | | * doc/contributing.texi (The Perfect Setup): Show "guix package -i" command line.
* doc: Update left-over references to lsh.Tobias Geerinckx-Rice2019-02-01
| | | | | * doc/guix.texi (Using the Configuration System, Defining Services): Refer to OpenSSH instead of lsh.
* doc: Clarify 'sudo' vs. 'guix pull' and 'guix system reconfigure'.Ludovic Courtès2019-01-28
| | | | | * doc/guix.texi (Proceeding with the Installation): Clarify use of "sudo" with "guix pull" and "guix system reconfigure".
* doc: Update bit about GUIX_LD_WRAPPER_ALLOW_IMPURITIES.Ludovic Courtès2019-01-26
| | | | | | | This is a followup to d0a2db47fb550d684c47a0ae3b541a9a71727d9e. * doc/guix.texi (Application Setup)[The GCC toolchain]: Adjust bit about GUIX_LD_WRAPPER_ALLOW_IMPURITIES.
* doc: Switch from "GuixSD" to "Guix System".Ludovic Courtès2019-01-26
| | | | | | | * 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.
* doc: Make /dev/kvm note more visible.Ludovic Courtès2019-01-26
| | | | | | | 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.
* weather: Add '--coverage'.Ludovic Courtès2019-01-25
| | | | | | | | | * 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.
* doc: Replace some cons* with beginner-friendly (append (list ...)).Pierre Neidhardt2019-01-23
| | | | * doc/guix.texi (Base Services): Do it.
* doc: Correct EFI-specific system configuration details.Pierre Neidhardt2019-01-23
| | | | | | | * 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.
* doc: Move "Package Modules" under "Programming Interface".Ludovic Courtès2019-01-22
| | | | | * doc/guix.texi (Package Modules): Move to... (Programming Interface): ... here. Turn into a section.
* doc: Move "Packaging Guidelines" under "Contributing".Ludovic Courtès2019-01-22
| | | | | | * doc/guix.texi (Packaging Guidelines): Move to... * doc/contributing.texi (Packaging Guidelines): ... here. Turn into a section. Adjust references to "Contributing".
* doc: Move "System Installation" right after "Installation".Ludovic Courtès2019-01-22
| | | | * doc/guix.texi (System Installation): Move right after "Installation".
* doc: Move sections under "GNU Distribution" one level higher.Ludovic Courtès2019-01-22
| | | | | | | | | | | | * 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.
* store: Rename '&nix-error' to '&store-error'.Ludovic Courtès2019-01-21
| | | | | | | | | | | | | | | | | | | * 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.
* services: openssh: Add escape hatch.Ricardo Wurmus2019-01-17
| | | | | * gnu/services/ssh.scm (<openssh-configuration>)[extra-content]: New field. * doc/guix.texi (Networking Services): Document it.
* doc: Document the graphical installer.Mathieu Othacehe2019-01-17
| | | | * doc/guix.texi (Preparing for Installation): Mention the graphical installer.
* doc: Add missing parameter to guix system reconfigureDamien Cassou2019-01-16
| | | | | | | * 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>
* services: avahi: Deprecate the 'avahi-service' procedure.Ludovic Courtès2019-01-16
| | | | | | | | | | | | * 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.
* guix build: Re-purpose '--verbosity' and add '--debug'.Ludovic Courtès2019-01-11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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'.
* services: Deprecate a few more service procedures.Ludovic Courtès2019-01-11
| | | | | | | | | | | | | | | | | | 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.
* services: Add docker.Danny Milosavljevic2019-01-10
| | | | | | * gnu/services/docker.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Miscellaneous Services): Document the service.
* build: Require Guile 2.2.Ludovic Courtès2019-01-09
| | | | | | | | * 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.
* doc: Recommend using the installer script.Ricardo Wurmus2019-01-08
| | | | | * doc/guix.texi (Installation): Make it clear that the installer script is the recommended, easy way to install Guix.
* lint: Check for unstable tarballs.Efraim Flashner2018-12-27
| | | | | | | | | | * 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.
* pull: Add '--system'.Ludovic Courtès2018-12-27
| | | | | | * guix/scripts/pull.scm (%options): Add '--system'. (guix-pull): Honor it. * doc/guix.texi (Invoking guix pull): Document it.
* offload: Use (guix inferior) instead of (ssh dist node).Ludovic Courtès2018-12-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* doc: Fix typo.Efraim Flashner2018-12-24
| | | | | | This is a follow-up to c39491829a0c1d870f8133b8f7a699152fc71503 * doc/guix.texi (Invoking guix refresh): Fix texinfo markup
* scripts: refresh: Allow searching recursively.Efraim Flashner2018-12-24
| | | | | | | | * guix/scripts/refresh.scm (refresh-recursive, list-transitive): New procedures. (show-help): Document it. (guix-refresh): Add flags and checks for new options. * doc/guix.texi (Invoking guix refresh): Document new options.
* services: Add quassel.Efraim Flashner2018-12-24
| | | | | | | | | * gnu/services/messaging.scm (<quassel-configuration>): New record type. (%quassel-account, %quassel-activation): New procedures. (quassel-service-type): New variable. * gnu/tests/messaging.scm (%test-quassel): New variable. (run-quassel-test): New procedure. * doc/guix.texi (Messaging): Document quassel service.
* guix: lint: Check for source URIs redirecting to GitHub.Arun Isaac2018-12-24
| | | | | | | * guix/scripts/lint.scm (check-github-uri): New procedure. (%checkers): Add it. * doc/guix.texi (Invoking guix lint): Document it. * tests/lint.scm ("github-url", "github-url: one suggestion"): New tests.
* doc: Fix ‘serice’ -> ‘service’ typos.Tobias Geerinckx-Rice2018-12-23
| | | | * doc/guix.texi (Web Services): Fix typos.
* doc: '--search' is case-insensitive.Ludovic Courtès2018-12-21
| | | | | | | Suggested by Chris Marusich <cmmarusich@gmail.com>. * doc/guix.texi (Invoking guix package): Mention that --search is case-insensitive.
* build: Add dune-build-system.Julien Lepiller2018-12-18
| | | | | | | | | | | * guix/build/dune-build-system.scm, guix/build-system/dune.scm: New files. * Makefile.am (MODULES): Add them. * doc/guix.texi (Build Systems): Document dune-build-system. * guix/build-system/ocaml.scm (lower, default-findlib, default-ocaml): Export them. (package-with-explicit-ocaml): Also transform packages built with dune-build-system.
* doc: Remove stale reference to 'hydra.gnu.org'.Ludovic Courtès2018-12-18
| | | | | | | Reported by Thomas Schmitt <scdbackup@gmx.net>. * doc/guix.texi (Binary Installation): Refer to SUBSTITUTE-SERVER, not to 'hydra.gnu.org'.
* guix system: Clarify the three strategies available.swedebugia2018-12-18
| | | | | | | | * guix/scripts/system.scm (show-help): Clarify the three choices. * doc/guix.texi (Invoking guix system): Add 3 @cindex to make on-error=strategy easier to find. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix typo in '.guix-channel' example.Ludovic Courtès2018-12-18
| | | | | * doc/guix.texi (Channels): Remove extra quote in '.guix-channel' example.
* doc: Replace 'https-port' with 'listen' in nginx php example.Jelle Licht2018-12-18
| | | | * doc/guix.texi (Web Services): Update accordingly.
* environment: Support package transformation options.Ludovic Courtès2018-12-17
| | | | | | | | | | | | | | Fixes <https://bugs.gnu.org/33776>. Reported by Adrien Guilbaud <adrien.guilbaud@inria.fr>. * guix/scripts/environment.scm (show-help): Add call to 'show-transformation-options-help'. (%options): Add %TRANSFORMATION-OPTIONS. (options/resolve-packages): Add 'store' parameter. [transform, package->manifest-entry*]: New procedures. Use 'package->manifest-entry*' instead of 'package->manifest-entry'. (guix-environment): Move definition of 'manifest' within 'with-store'. * tests/guix-environment.sh: Add test.
* services: udev: Add 'rules' action.Ludovic Courtès2018-12-17
| | | | | | * gnu/services/base.scm (udev-shepherd-service): Add 'actions' field. * doc/guix.texi (Base Services): Move "@end deffn" after 'udev-service' definition. Mention 'herd rules udev'.
* services: monitoring: Add 'zabbix-front-end'.Oleg Pykhalov2018-12-17
| | | | | | | | | | * gnu/services/monitoring.scm (nginx-server-configuration-list?, serialize-nginx-server-configuration-list, zabbix-front-end-configuration, zabbix-front-end-config, zabbix-front-end-activation, generate-zabbix-front-end-documentation): New procedures. (%zabbix-front-end-configuration-nginx, %maintenance.inc.php, zabbix-front-end-service-type): New variables. * doc/guix.texi (Monitoring Services): Document this.
* services: php-fpm: Add 'timezone' configuration.Oleg Pykhalov2018-12-17
| | | | | | | * gnu/services/web.scm: (<php-fpm-configuration>)[timezone]: New record field. (default-php-fpm-config, php-fpm-shepherd-service, php-fpm-activation): Use this. * doc/guix.texi (Web Services): Document this.
* services: monitoring: Add 'zabbix-agent'.Oleg Pykhalov2018-12-17
| | | | | | | | | | | * gnu/services/monitoring.scm (zabbix-server-service-type, zabbix-agent-account, zabbix-agent-activation, zabbix-agent-config-file, zabbix-agent-shepherd-service, generate-zabbix-agent-documentation): New procedures. (zabbix-agent-service-type): New 'service-type'. * gnu/tests/monitoring.scm (run-zabbix-server-test): Test 'zabbix-agent'. (%zabbix-os): Add 'zabbix-agent' service. * doc/guix.texi (Monitoring Services): Document 'zabbix-agent'.
* services: monitoring: Add 'zabbix-server'.Oleg Pykhalov2018-12-17
| | | | | | | | | | | | | | | | | * gnu/services/monitoring.scm (uglify-field-name, serialize-field, serialize-number, serialize-list, serialize-string, group?, serialize-group, include-files?, serialize-include-files, zabbix-server-account, zabbix-server-config-file, zabbix-server-activation, zabbix-server-shepherd-service, generate-zabbix-server-documentation, extra-options, serialize-extra-options): New procedures. (zabbix-server-service-type): New variable. * gnu/tests/monitoring.scm (%psql-user-create-zabbix, %psql-db-zabbix-create-script, %psql-db-create-zabbix, %psql-db-import-zabbix, %zabbix-os, %test-zabbix): New variables. (run-zabbix-server-test): New procedure. * doc/guix.texi (Monitoring Services): Document 'zabbix-server'. squash! services: monitoring: Add 'zabbix-server'.
* doc: Replace @command by @code for packagesPierre Neidhardt2018-12-15
| | | | | * doc/contributing.texi (Submitting Patches): Replace @command by @code for packages.
* doc: Merge "discourage use of texlive" with existing paragraph on "guix size"Pierre Neidhardt2018-12-15
| | | | | * doc/contributing.texi (Submitting Patches): Merge "discourage use of texlive" with existing paragraph on "guix size".
* doc: Discourage the use of texlive as inputPierre Neidhardt2018-12-14
| | | | | * doc/contributing.texi (Submitting Patches): Discourage the use of texlive as input.
* guix: Add support for channel dependencies.Ricardo Wurmus2018-12-09
| | | | | | | | | | | | * guix/channels.scm (<channel-metadata>): New record. (read-channel-metadata, channel-instance-dependencies): New procedures. (latest-channel-instances): Include channel dependencies; add optional argument PREVIOUS-CHANNELS. (channel-instance-derivations): Build derivation for additional channels and add it as dependency to the channel instance derivation. * doc/guix.texi (Channels): Add subsection "Declaring Channel Dependencies". * tests/channels.scm: New file. * Makefile.am (SCM_TESTS): Add it.
* doc: Update "Limitations".Ludovic Courtès2018-12-05
| | | | * doc/guix.texi (Limitations): Update package count.
* doc: Update substitute server.Ludovic Courtès2018-12-04
| | | | | | | Fixes an accidental revert in commit 0a5fa004f7f21dc3e01747b8e94fbb21e056e4ca. * doc/guix.texi (SUBSTITUTE-SERVER): Really change to ci.guix.info.