summaryrefslogtreecommitdiff
path: root/doc/guix.texi
AgeCommit message (Collapse)Author
2022-01-10style: Add '--styling' option.Ludovic Courtès
* guix/scripts/style.scm (format-package-definition): New procedure. (%options, show-help): Add "--styling". (%default-options): Add 'styling-procedure'. (guix-style): Honor it. * tests/style.scm (with-test-package) ("input labels, 'safe' policy") ("input labels, 'safe' policy, nothing changed") ("input labels, margin comment") ("input labels, margin comment on long list") ("input labels, line comment") ("input labels, modify-inputs and margin comment"): Pass "-S inputs". * etc/indent-code.el: Remove. * doc/contributing.texi (Formatting Code): Mention "guix style" instead of "etc/indent-code.el". (Submitting Patches): Add item for "guix style". * doc/guix.texi (Invoking guix style): Document "-S" and update.
2022-01-10build: julia-build-system: Create 'Project.toml' file when missing.zimoun
* guix/build/julia-build-system.scm (link-depot): Create 'Project.toml' file when missing using data provided by the user. (julia-create-package-toml): Remove from export. * doc/guix.texi (Build Systems): Update julia-build-system section. Signed-off-by: Efraim Flashner <efraim@flashner.co.il>
2022-01-10doc: Fix some typos.Tobias Geerinckx-Rice
* doc/guix.texi (Invoking guix hash): Fix a few typos today. Reported by KarlJoad on #guix, and then we found more.
2022-01-07doc: Fix typo.Jelle Licht
* doc/guix.texi (Essential Home Services): Fix typo.
2022-01-07doc: Use a better setuid example.Tobias Geerinckx-Rice
nmtui does not benefit from being setuid. Oops. * doc/guix.texi (Setuid Programs): Replace network-manager's /bin/nmtui with nfs-utils' /sbin/mount.nfs. Change a @code{} to a @command{}.
2022-01-06doc: Fix typo.Tobias Geerinckx-Rice
* doc/guix.texi (Build Utilities): Fix typo. Reported by Mortimer Cladwell <mbcladwell@gmail.com>
2022-01-03doc: Try to clarify the setuid programs examples.Leo Famulari
Based on user feedback, the shadow / passwd example was too obscure for those who aren't familiar with the shadow collection of tools. And it was also considered confusing for the two examples to use different packages. * doc/guix.texi (Setuid Programs): Use 'nmtui' in the examples.
2022-01-03doc: Avoid (getenv "HOME") in 'machines.scm' example.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/52517>. Reported by zimoun <zimon.toutoune@gmail.com>. * doc/guix.texi (Daemon Offload Setup): Avoid misleading (getenv "HOME") in example.
2022-01-03doc: Document clauses of 'modify-inputs'.Ludovic Courtès
Suggested by Alexander Asteroth <alexander.asteroth@h-brs.de>. * doc/guix.texi (Defining Package Variants): Document all the supported clauses of 'modify-inputs'.
2022-01-02services: guix-build-coordinator: Fix variable name in agent config.Christopher Baines
* gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): Fix variable name. * doc/guix.texi (Guix Services): Update accordingly.
2022-01-02gnu: Add guix-build-coordinator/agent-only.Christopher Baines
This avoids issues where the coordinator component dependencies (like sqitch and guile-fibers) make it harder to use the agent. * gnu/packages/package-management.scm (guix-build-coordinator/agent-only): New variable. * gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): Use the guix-build-coordinator/agent-only package by default. * doc/guix.texi (Guix Services): Update accordingly.
2022-01-01transformations: Add '--tune'.Ludovic Courtès
* guix/transformations.scm (tuning-compiler) (tuned-package, tunable-package?, package-tuning) (transform-package-tuning) (build-system-with-tuning-compiler): New procedures. (%transformations): Add 'tune'. (%transformation-options): Add "--tune". * tests/transformations.scm ("options->transformation, tune") ("options->transformations, tune, wrong micro-architecture"): New tests. * doc/guix.texi (Package Transformation Options): Document '--tune'.
2022-01-01system: Allow 'chfn' to change the user's full name.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/52539>. Reported by Jacob First <jacob.first@member.fsf.org>. * gnu/build/accounts.scm (allocate-passwd): Add comment as to why 'real-name' is taken from PREVIOUS. Add (not system?) to the condition. * gnu/system.scm (operating-system-etc-service) <login.defs>: Add "CHFN_RESTRICT". * gnu/system.scm (%setuid-programs): Add "chfn". * gnu/system/pam.scm (base-pam-services): Add "chfn". * doc/guix.texi (User Accounts): Document it.
2021-12-26doc: Give a complete example of adding setuid programs.Leo Famulari
* doc/guix.texi (Setuid Programs): Give a complete example of how to use SETUID-PROGRAM.
2021-12-23scripts: system: Deprecate the docker-image command.Mathieu Othacehe
* guix/scripts/system.scm (system-derivation-for-action): Use the image API to generate the docker images and deprecate the docker-image command. (process-action): Ditto. * doc/guix.texi (Invoking guix system): Adapt it.
2021-12-23Remove VM generation dead-code.Mathieu Othacehe
This code duplicates the (gnu system image) and (gnu build image) code. Using VM for image generation is not needed, not portable and really slow. Remove all the VM image generation code to make sure that only the image API is used. * gnu/build/vm.scm: Remove it. Move the qemu-command procedure to ... * gnu/build/marionette.scm: ... here. * gnu/local.mk (GNU_SYSTEM_MODULES): Adapt it. * tests/modules.scm: Ditto. * gnu/tests/install.scm: Ditto. * gnu/system/vm.scm: Adapt it and remove expression->derivation-in-linux-vm, qemu-img, system-qemu-image/shared-store and system-docker-image procedures. * doc/guix.texi (G-Expressions): Adapt it.
2021-12-22doc: Document (gnu services configuration).Xinglu Chen
* guix.texi (Complex Configurations): New node. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-12-22services: wireguard: Add DNS config field.Nathan Dehnel
* gnu/services/vpn.scm (wireguard-configuration)[dns]: New field. (wireguard-configuration-file): Honor it. * doc/guix.texi: Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-12-21services: rsync: Allow configuring several rsync "modules".Ludovic Courtès
Until now the rsync service would export a single module, named "files". This allows users to specify as many modules as they want, in line with rsyncd.conf(5). * gnu/services/rsync.scm (warn-share-field-deprecation): New procedure. (<rsync-configuration>)[modules]: New field. [share-path, share-comment, read-only?, timeout]: Mark as deprecated. (<rsync-module>): New record type. (%default-modules): New variable. (rsync-configuration-modules): New procedure. (rsync-activation): Create the directory of each module. (rsync-config-file): Generate configuration for each module. (rsync-service-type)[description]: New field. * doc/guix.texi (Networking Services): Adjust documentation. Augment example.
2021-12-20doc: Fix wrong home-shepherd-configuration data type.Olivier Dion
* doc/guix.texi (Managing User's Daemons): Rename shepherd-configuration for home-shepherd-configuration. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-12-17doc: Format 'guix hash -S' values as a table.Ludovic Courtès
* doc/guix.texi (Invoking guix hash): Format serializer types as a table.
2021-12-17guix hash: Add git serializer.zimoun
* guix/scripts/hash.scm (git-hash): New procedure. (%options): Use it. * tests/guix-hash.sh: Test it. * doc/guix.texi: Update. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-12-17guix hash: Add 'serializer' option.zimoun
* guix/scripts/hash.scm (%options): Deprecate 'recursive', add 'serializer'. (%default-options): Add 'serializer'. (nar-hash): New procedure. (default-hash): New procedure. (guix-hash)[file-hash]: Use them. (show-help): Adjust. * tests/guix-hash.scm: Adjust. * doc/guix.texi: Update. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-12-17guix hash: Support several files.zimoun
* guix/scripts/hash.scm (guix-hash): Allow several files. [file-hash]: Catch system-error. [formatted-hash]: New procedure. * tests/guix-hash.sh: Add test. * doc/guix.texi (Invoking guix hash): Mention "one or more files". Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-12-15doc: Do not explain quote/quasiquote in the context of inputs.Ludovic Courtès
* doc/guix.texi (Defining Packages): Move reference to quote/quasiquote from 'inputs' to 'arguments'.
2021-12-15doc: Use @lisp for 'static-networking-service-type' example.Ludovic Courtès
* doc/guix.texi (Networking Setup): Use @lisp for 'static-networking-service-type' example.
2021-12-14doc: Mention powerpc-linux support.Efraim Flashner
This was missing with the addition of powerpc-linux support in commit cbdb7d4fea928febc105985c03b8fb5d6eda3d27. * doc/guix.texi (GNU Distribution): Add powerpc-linux.
2021-12-14doc: Mark mips64el-linux as unsupported.Efraim Flashner
* doc/guix.texi (GNU Distribution): Change mips64el-linux from deprecated to unsupported.
2021-12-13Merge branch 'master' into core-updates-frozenLudovic Courtès
2021-12-13doc: Add missing closing paren.Ludovic Courtès
* doc/guix.texi (Desktop Services): Add missing closing paren in example.
2021-12-12services: Define '%loopback-static-networking'.Ludovic Courtès
* gnu/services/base.scm (%loopback-static-networking): New variable. (%base-services): Use it. * gnu/system/hurd.scm (%base-services/hurd): Use it. * gnu/system/install.scm (%installation-services): Use it. * doc/guix.texi (Networking Setup): Document it.
2021-12-12services: Define '%qemu-static-networking'.Ludovic Courtès
* gnu/services/base.scm (%qemu-static-networking): New variable. * gnu/system/hurd.scm (%base-services/hurd): Use it. * doc/guix.texi (Networking Setup): Document it.
2021-12-12services: static-networking: Change interface to mimic netlink.Ludovic Courtès
* gnu/services/base.scm (<static-networking>)[interface, ip, netmask] [gateway]: Remove. [addresses, links, routes]: New fields. [requirement]: Default to '(udev). (<network-address>, <network-link>, <network-route>): New record types. (ensure-no-separate-netmask, %ensure-no-separate-netmask): Remove. (ipv6-address?, cidr->netmask, ip+netmask->cidr) (network-set-up/hurd, network-tear-down/hurd) (network-set-up/linux, network-tear-down/linux) (static-networking->hurd-pfinet-options): New procedures. (static-networking-shepherd-service): New procedure. (static-networking-shepherd-services): Rewrite in terms of the above. (static-networking-service): Deprecate. Adjust to new 'static-networking' API. (%base-services): Likewise. * gnu/system/install.scm (%installation-services): Likewise. * gnu/system/hurd.scm (%base-services/hurd): Likewise, and separate 'loopback' from 'networking'. * gnu/build/hurd-boot.scm (set-hurd-device-translators): Remove "servers/socket/2". * gnu/tests/networking.scm (run-openvswitch-test)["networking has started on ovs0"]: Check for 'networking instead of 'networking-ovs0, which is no longer provided. * doc/guix.texi (Networking Setup): Document the new interface. Remove documentation of 'static-networking-service'. (Virtualization Services): Change Ganeti example to use the new interface.
2021-12-12doc: Add new "Networking Setup" node for the main setup options.Ludovic Courtès
This should make it easier to find how to get started setting up networking. * doc/guix.texi (Networking Setup): New section. (Networking Services): Remove 'static-networking-service', 'dhcp-client-service-type', 'network-manager-service-type', 'connman-service-type', 'wicd-service', 'modem-manager-service-type', 'usb-modeswitch-service-type', and 'wpa-supplicant-service-type'.
2021-12-05Merge remote-tracking branch 'origin/master' into core-updates-frozenRicardo Wurmus
2021-12-03guix system vm: Add --no-graphic CLI argument.Attila Lendvai
It configures QEMU to use the tty it was started in for IO (as opposed to opening a separate graphical window). This enables copy-pasting and scrollback. Exit QEMU with C-a x. * gnu/system/vm.scm (system-qemu-image/shared-store-script): Also add the '-nographic' QEMU argument when called with #:graphic? #false. * guix/scripts/system.scm (system-derivation-for-action): Propagate the #:graphic? keyword arg. (perform-action): Add and propagate the #:graphic? keyword arg. (show-help): Add --no-graphic CLI arg. (%options): Process the new --no-graphic CLI arg. (process-action): Feed in the CLI arg through the #:graphic? keyword arg. * doc/guix.texi (Invoking guix system): Add example to combine guix system and invoking the vm start script into one command. Split the description of the various options into separate paragraphs. Add a paragraph to describe --no-graphic. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-12-01doc: Document LUKS2 GRUB support and shortcomingsJosselin Poiret
* doc/guix.texi (Keyboard Layout, Networking, and Partitioning)[Disk Partitioning]: Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-29gnu: guix-build-coordinator: Update to 0-40.226ec0f.Christopher Baines
* gnu/packages/package-management.scm (guix-build-coordinator): Update to 0-40.226ec0f. * doc/guix.texi (Guix Build Coordinator): Remove note about the service being considered experimental, it's been stable for a while now.
2021-11-27services: Document the 'delete' clause of 'modify-services'.Ludovic Courtès
* doc/guix.texi (Service Reference): Mention the 'delete' clause of 'modify-services'. * gnu/services.scm (modify-services): Likewise in docstring.
2021-11-23style: Add '--dry-run'.Ludovic Courtès
* guix/scripts/style.scm (edit-expression/dry-run): New procedure. (simplify-package-inputs): Add #:edit-expression parameter. (%options, show-help): Add '--dry-run'. (guix-style): Honor '--dry-run'.
2021-11-23Merge branch 'master' into core-updates-frozenLudovic Courtès
2021-11-23doc: Add new Swap Space section.Josselin Poiret
* doc/guix.texi (operating-system Reference): Update swap-devices. * doc/guix.texi (Swap Space): Add it. * gnu/system/examples/desktop.tmpl: Add swap-devices example. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-23doc: Fix the example of "Using virt-viewer with Spice".Rostislav Svoboda
* doc/guix.texi (Running Guix in a Virtual Machine): add missing line continuation char '\'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17Merge branch 'master' into core-updates-frozenLudovic Courtès
2021-11-17scripts: home: Make ‘guix home import’ write home-configuration.scm.Xinglu Chen
* guix/scripts/home.scm (process-command): Populate ‘home-configuration.scm’ in the destination directory instead of printing to stdout. * doc/guix.texi (Declaring the Home Environment): Adjust accordingly. (Invoking guix home): Likewise. Suggested-by: Ludovic Courtès <ludo@gnu.org> Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17services: docker: Add 'environment-variables' configuration field.Alexey Abramov
* gnu/services/docker.scm (docker-configuration): Add the field (docker-shepherd-service): Pass the list of defined variables to make-forkexec-constructor. * doc/guix.texi (Miscellaneous Services): Update doc. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17import: Replace texlive importer.Ricardo Wurmus
* guix/import/texlive.scm (fetch-sxml, sxml->package): Remove procedures. (tlpdb-file, tlpdb, files->directories, tlpdb->package): New procedures. (string->license): Add case for lpplgpl license combination. (guix-name): Remove COMPONENT argument. (texlive->guix-package): Use new procedures. (texlive-recursive-import): New procedure. * guix/scripts/import/texlive.scm (show-help, %options): Remove --archive option. (guix-import-texlive): Adjust call of texlive->guix-package. * doc/guix.texi (Invoking guix import): Update documentation.
2021-11-16services: cups: Update default timeouts.Tobias Geerinckx-Rice
Upstream raised these back in 2019 with CUPS 2.3.0. * gnu/services/cups.scm (<cups-configuration>): Raise default ‘multiple-operation-timeout’ and ‘timeout’ from 300 to 900 seconds. * doc/guix.texi (Printing Services): Adjust accordingly.
2021-11-16doc: Remove obsolete example module import.Tobias Geerinckx-Rice
This follows up on commit a247f5c7537df7e0c09051ba22d5c95eb08f48b9. * doc/guix.texi (X Window): Remove unused (srfi srfi-1) from the modify-services example.
2021-11-15gnu: hpcguix-web: Update to 0.2.0.Ludovic Courtès
* gnu/packages/web.scm (hpcguix-web): Update to 0.2.0. [arguments]: In 'wrap-program' phase, add guile-zlib to DEPS. [native-inputs]: Add GUILE. [inputs]: Add GUILE-ZLIB, GUILE-COMMONMARK, and GUILE-JSON. [propagated-inputs]: Remove. These were pointless. * gnu/services/web.scm (<hpcguix-web-configuration>)[address, port]: New fields. * doc/guix.texi (Web Services): Document them. * gnu/tests/web.scm (%hpcguix-web-os): Add 'address'.