summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2020-07-01guix describe: Display channel introductions and add 'channels-sans-intro'.Ludovic Courtès
* guix/scripts/describe.scm (%available-formats): Add "channels-sans-intro". (channel->sexp): Add #:include-introduction?. Emit CHANNEL's intro if INCLUDE-INTRODUCTION? is true and CHANNEL has an introduction. (channel->json): Include CHANNEL's introduction, if any. (channel->recutils): Likewise. (display-profile-info): Add 'channels-sans-intro' case. * doc/guix.texi (Invoking guix describe): Add introduction in example. Add 'channels-sans-intro' case.
2020-07-01channels: Make channel introductions public.Ludovic Courtès
* guix/channels.scm (<channel-introduction>): Rename constructor to '%make-channel-introduction'. (make-channel-introduction): New procedure. * tests/channels.scm ("authenticate-channel, wrong first commit signer") ("authenticate-channel, .guix-authorizations"): Use 'make-channel-introduction' without '@@' and without third argument. * doc/guix.texi (Channels)[Channel Authentication, Specifying Channel Authorizations]: New subsections.
2020-06-28doc: cookbook: Fix encoding of "André".Ludovic Courtès
This is a followup to f8945734a5abff69644284231cc47fb67456657b. * doc/guix-cookbook.texi: Encode "André" as UTF-8, not ISO-8859-1.
2020-06-28doc: Add progress display in 'dd' command lines.Brice Waegeneire
* doc/guix.texi (System Installation): Adjust 'dd' command line to display progress … (System Configuration): … same here.
2020-06-28doc: cookbook: Update entry about getting substitutes through Tor.André Batista
* doc/guix-cookbook.texi (Getting substitutes from Tor): Update section warning to mention the use of torsocks when pulling.
2020-06-28services: Add rshiny service.Efraim Flashner
* gnu/services/science.scm: New file. (<rshiny-configuration>): New record. (rshiny-shepherd-service-type): New variable. * doc/guix.texi (Miscellaneous Services): Document it. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it.
2020-06-26doc: 'guix hash' is not SHA256-only.Ludovic Courtès
This is a followup to 18ae1ec3ecfe22d55d6cdf595a442afebbc5595a. * doc/guix.texi (Invoking guix hash): Remove "SHA256" from the first paragraph.
2020-06-23doc: cookbook: Fix typos.Ludovic Courtès
* doc/guix-cookbook.texi (Extended example): Fix typos.
2020-06-23doc: cookbook: Tweak intro to the REPL.Ludovic Courtès
* doc/guix-cookbook.texi (A Scheme Crash Course): Reword first paragraph. Remove extra paren.
2020-06-23doc: cookbook: Mention "guix hash -rx" for Git checkouts.Ludovic Courtès
* doc/guix-cookbook.texi (Extended example): Mention "guix hash -rx ."
2020-06-23doc: cookbook: Clarify 'git-fetch' conventions.Ludovic Courtès
* doc/guix-cookbook.texi (Extended example): Clarify use of 'git-file-name' and 'git-version'.
2020-06-21services: childhurd: Support more than one instance.Jan (janneke) Nieuwenhuizen
* gnu/services/virtualization.scm (<hurd-vm-configuration>)[options]: Remove "--hda" option. [id,net-options]: New fields. (hurd-vm-net-options): New procedure. Parameterize port forwarding with ID. * gnu/services/virtualization.scm (hurd-vm-shepherd-service): Use them. Parameterize provision with ID, if set. Hardcode "--hda" option for image. * doc/guix.texi (Virtualization Services): Document new fields. Update for hardcoding of "--hda".
2020-06-20doc: Make issues.guix.gnu.org more visible.Ludovic Courtès
* doc/contributing.texi (Tracking Bugs and Patches): Make issues.guix.gnu.org more visible, update issue URL.
2020-06-18doc: Delete description of a nonexistent option.Timotej Lazar
* doc/guix.texi (Invoking guix pull): Delete a paragraph about the --verbose option, which was removed in 1edcfda81ba5c20ca715473d45315662c60dd81e. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-06-17channels: Warn when pulling from a mirror.Ludovic Courtès
* guix/channels.scm (<channel-metadata>)[url]: New field. (read-channel-metadata): Initialize it. (read-channel-metadata-from-source): Likewise. (channel-instance-primary-url): New procedure. (latest-channel-instances): Compare CHANNEL's URL against it. * doc/guix.texi (Channels)[Primary URL]: New subsection.
2020-06-16pull: Add '--disable-authentication'.Ludovic Courtès
* guix/channels.scm (latest-channel-instance): Add #:authenticate? and honor it. (latest-channel-instances): Likewise. * guix/scripts/pull.scm (%default-options): Add 'authenticate-channels?'. (show-help, %options): Add '--disable-authentication'. (guix-pull): Pass #:authenticate? to 'latest-channel-instances'. * doc/guix.texi (Invoking guix pull): Document it.
2020-06-16channels: 'latest-channel-instance' authenticates Git checkouts.Ludovic Courtès
Fixes <https://bugs.gnu.org/22883>. * guix/channels.scm (<channel>)[introduction]: New field. (<channel-introduction>): New record type. (%guix-channel-introduction): New variable. (%default-channels): Use it. (<channel-metadata>)[keyring-reference]: New field. (%default-keyring-reference): New variable. (read-channel-metadata, read-channel-metadata-from-source): Initialize the 'keyring-reference' field. (commit-short-id, verify-introductory-commit) (authenticate-channel): New procedures. (latest-channel-instance): Call 'authenticate-channel' when CHANNEL has an introduction. * tests/channels.scm (gpg+git-available?, commit-id-string): New procedures. ("authenticate-channel, wrong first commit signer"): ("authenticate-channel, .guix-authorizations"): New tests. * doc/guix.texi (Invoking guix pull): Mention authentication.
2020-06-16doc: Recommend "make authenticate" after ./bootstrap.Ludovic Courtès
* doc/contributing.texi (Building from Git): Move "make authenticate" instructions below.
2020-06-16pack: Add zstd compressor.Tobias Geerinckx-Rice
* guix/scripts/pack.scm (%compressors): Add zstd. * doc/guix.texi (Invoking guix pack): Document it.
2020-06-15doc: Clarify 'hurd-vm' and 'childhurd' names.Jan (janneke) Nieuwenhuizen
Suggested by Maxim Cournoyer via IRC. * doc/guix.texi (The Hurd in a Virtual Machine): Explicitly mention that hurd-vm and childhurd are two names for this service.
2020-06-14doc: Adjust branching and rebuilding strategy to match reality.Marius Bakke
The amount of packages has more than tripled since this section was written. Adjust the rebuild limits and cycle lengths based on current practices. * doc/contributing.texi (Submitting Patches): Increase 'staging' rebuild limit to 1800 packages, and adjust the cycle to six weeks. Increase 'core-updates' cycle to six months.
2020-06-14guix repl: Add script execution.Konrad Hinsen
* guix/scripts/repl.scm: Add filename options for script execution. * doc/guix.texi (Invoking guix repl): Document it. * tests/guix-repl.sh: Test it. * Makefile.am: (SH_TESTS): Add it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-06-14services: Add 'hurd-vm service-type'.Jan (janneke) Nieuwenhuizen
* gnu/services/virtualization.scm (hurd-vm-shepherd-service, hurd-vm-disk-image): New procedures. (%hurd-vm-operating-system, hurd-vm-service-type): New variables. (<hurd-vm-configuration>): New record type. * doc/guix.texi (Virtualization Services): Document it. * gnu/services/shepherd.scm (scm->go): Use let-system, remove FIXME. Fixes fixes cross-building of shepherd modules for the Hurd image.
2020-06-14lint: Add 'check-for-collisions' checker.Ludovic Courtès
Suggested by Edouard Klein <edk@beaver-labs.com>. * guix/profiles.scm (check-for-collisions): Export. * guix/lint.scm (check-profile-collisions): New procedure. (%local-checkers): Add 'profile-collisions' checker. * tests/lint.scm ("profile-collisions: no warnings") ("profile-collisions: propagated inputs collide") ("profile-collisions: propagated inputs collide, store items"): New tests. * doc/guix.texi (Invoking guix lint): Document it.
2020-06-14doc: Mention 'guix lint -c derivation'.Ludovic Courtès
* doc/guix.texi (Invoking guix lint): Mention the 'derivation' checker.
2020-06-09doc: Add note to 'udisks-service'.Brice Waegeneire
* doc/guix.texi (Desktop Services): Specify how to add file-systems utilities to 'udisks-service'.
2020-06-08services: Add `hurd-getty-service-type'.Jan (janneke) Nieuwenhuizen
* gnu/services/hurd.scm (<hurd-gettty-configuration>): New record. (hurd-ttys-shepherd-service): New procedure. (hurd-getty-service-type): New variable. * doc/guix.texi (Hurd Services): Document it.
2020-06-08services: Add `hurd-console-service-type'.Jan (janneke) Nieuwenhuizen
* gnu/services/hurd.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Hurd Services): Document it.
2020-06-08bootloader: Extend `<menu-entry>' for multiboot.Jan (janneke) Nieuwenhuizen
* gnu/bootloader.scm (<menu-entry>)[multiboot-kernel,multiboot-arguments, multiboot-modules]: New fields. [linux,initrd]: Add default value '#f'. (menu-entry->sexp, sexp->menu-entry): Support multiboot entry. * doc/guix.texi (Bootloader Configuration): Document them.
2020-06-08system: Add 'hurd' field to <operating-system>.Jan (janneke) Nieuwenhuizen
* gnu/system.scm (<operating-system>)[hurd]: New field. * doc/guix.texi (operating-system Reference): Document 'hurd'.
2020-06-04doc: cookbook: Add entry about getting substitutes through Tor.Brice Waegeneire
* doc/guix-cookbook.texi (Getting substitutes from Tor): New section.
2020-06-03doc: Mention Btrfs compression.Ludovic Courtès
Suggested by Pierre Neidhardt <mail@ambrevar.xyz>. * doc/guix.texi (Keyboard Layout and Networking and Partitioning): Mention Btrfs compression.
2020-06-03gnu: services: docker: Add a debug? parameter.Maxim Cournoyer
* gnu/services/docker.scm (docker-configuration): Add a debug? field. (containerd-shepherd-service): Pass the "--log-level=debug" argument when DEBUG? is true. (docker-shepherd-service): Pass the "--debug" and "--log-level=debug" arguments when DEBUG? is true. * doc/guix.texi (Miscellaneous Services): Update doc.
2020-06-02doc: cookbook: Add entry about Wireguard VPN.Marcin Karpezo
Co-authored-by: Brice Waegeneire <brice@waegenei.re> * doc/guix-cookbook.texi (Connect to Wireguard VPN): New section.
2020-05-29services: nfs: Expose configuration options for TCP and UDP.Maxim Cournoyer
* gnu/services/nfs.scm (<nfs-configuration>)[nfsd-tcp?, nfsd-udp?]: New fields. (nfs-shepherd-services)[rpc.nfsd]: Populate the --{no-,}tcp and --{no-,}udp command line options based on the values of the nfsd-tcp? and nfsd-upd? fields. * doc/guix.texi (Network File System): Add doc.
2020-05-29doc: Add example to calculate the size a system.Pierre Neidhardt
* doc/guix.texi (Invoking `guix size'): Add guix size example for store item.
2020-05-28doc: Remove explicit support for mips64el-linux.Efraim Flashner
It's been a good run, but no one is maintaining the architecture. So long, and thanks for all the fish. * doc/guix.texi (GNU Distribution): Change text for mips64el-linux to denote it is deprecated. (Daemon Offload Setup): Change occurrences of mips64el-linux to aarch64-linux and adjust local code snippets. (Guix Environment)[cross-compilation]: Change mips64el-linux-gnu to aarch64-linux-gnu. (GNU Build System)(package-cross-derivation]: Same. (G-Expressions)[cross compilation]: Same. (Additional Build Options)[cross-compilation, build logs]: Same. (qemu-binfmt-service-type): Remove mips64el. * doc/contributing.texi (Submitting Patches): Same. * m4/guix.m4: (GUIX_ASSERT_SUPPORTED_SYSTEM): Remove mips64el-linux.
2020-05-27doc: Use existing URLs and file names in installation instructions.Julien Lepiller
Some users are confused that these URLs and file names don't work, so change them to the most popular architecture, while still mentioning alternatives. * doc/guix.texi (USB Stick and DVD Installation, Binary Installation): Use x86_64-linux URLs by default.
2020-05-25doc: Remove one use of 'file-append*'.Ludovic Courtès
* doc/build.scm (texinfo-manual-source)[build]: Use 'file-append', not 'file-append*', for 'htmlxref.cnf', to ensure it has the right basename.
2020-05-25doc: Fix typos.zimoun
* doc/guix.texi: Fix typos. * doc/contributing.texi: Fix typos. Signed-off-by: Julien Lepiller <julien@lepiller.eu>
2020-05-25pull: Protect against downgrade attacks.Ludovic Courtès
* guix/scripts/pull.scm (%default-options): Add 'validate-pull'. (%options, show-help): Add '--allow-downgrades'. (warn-about-backward-updates): New procedure. (guix-pull): Pass #:current-channels and #:validate-pull to 'latest-channel-instances'. * guix/channels.scm (ensure-forward-channel-update): Add hint for when (channel-commit channel) is true. * doc/guix.texi (Invoking guix pull): Document '--allow-downgrades'.
2020-05-25doc: cookbook: Add subsection about session locking with xss-lock.Chris Bøg
* doc/guix-cookbook.texi (Session lock): New node. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-05-24doc: Update to the new 'grub-theme' procedure.Jan (janneke) Nieuwenhuizen
This is a follow-up commit to 9cdb10d52e34f7e8fa3b6238fe268646a4bbb877: gnu: grub: Allow a PNG image and replace "aspect-ratio" with "resolution". * doc/guix.texi (Bootloader Configuration): Describe and use the 'grub-theme' procedure instead of the removed '%default-theme' variable.
2020-05-22doc: Update 'Bootstrapping' for further binary seed reduction.Jan Nieuwenhuizen
* doc/images/gcc-core-mesboot0-graph.dot: New image, replacing * doc/images/gcc-mesboot0-bag-graph.dot: ... remove file. * doc/local.mk (DOT_FILES): Update for new image file. * doc/guix.texi (Reduced Binary Seed Bootstrap): Use it in updated description of further reduction of the trusted computing base.
2020-05-22packages: Introduce <content-hash> and use it in <origin>.Ludovic Courtès
* guix/packages.scm (<content-hash>): New record type. (define-content-hash-constructor, build-content-hash) (content-hash): New macros. (print-content-hash): New procedure. (<origin>): Rename constructor to '%origin'. [sha256]: Remove field. [hash]: New field. Adjust users. (origin-compatibility-helper, origin): New macros. (origin-sha256): New deprecated procedure. (origin->derivation): Adjust accordingly. * tests/packages.scm ("package-source-derivation, origin, sha512"): New test. * guix/tests.scm: Hide (gcrypt hash) 'sha256' for proper syntax matching. * tests/challenge.scm: Add #:prefix for (gcrypt hash) and adjust users. * tests/derivations.scm: Likewise. * tests/store.scm: Likewise. * tests/graph.scm ("bag DAG, including origins"): Provide 'sha256' field with the right length. * gnu/packages/aspell.scm (aspell-dictionary) (aspell-dict-ca, aspell-dict-it): Use 'hash' and 'content-hash' for proper syntax matching. * gnu/packages/bash.scm (bash-patch): Rename 'sha256' to 'sha256-bv'. * gnu/packages/bootstrap.scm (bootstrap-executable): Rename 'sha256' to 'bv'. * gnu/packages/readline.scm (readline-patch): Likewise. * gnu/packages/virtualization.scm (qemu-patch): Rename 'sha256' to 'sha256-bv'. * guix/import/utils.scm: Hide (gcrypt hash) 'sha256'.
2020-05-22guix hash, guix download: Support base64 format.Ludovic Courtès
* guix/scripts/download.scm (show-help, %options): Support "base64" format. * guix/scripts/hash.scm (show-help, %options): Likewise. * tests/guix-hash.sh: Test it. * doc/guix.texi (Invoking guix hash): Document it.
2020-05-22guix hash, guix download: Add '--hash'.Ludovic Courtès
* guix/scripts/download.scm (%default-options): Add 'hash-algorithm'. (show-help, %options): Add "--hash". (guix-download): Honor it. * guix/scripts/hash.scm (%default-options): Add 'hash-algorithm'. (show-help, %options): Add "--hash". (guix-hash): Honor it. * tests/guix-hash.sh: Test '-H sha512'. * doc/guix.texi (Invoking guix download): Document it. (Invoking guix hash): Document it.
2020-05-22maint: Add "make check-channel-news".Ludovic Courtès
* build-aux/check-channel-news.scm: New file. * Makefile.am (EXTRA_DIST): Add it. (check-channel-news): New phony rule. * doc/contributing.texi (Commit Access): Mention "make check-channel-news".
2020-05-22doc: Use "Alternatively" instead of "Alternately".Ludovic Courtès
These two words have different meanings and we really meant "alternatively" here. * doc/guix.texi (System Installation): (Preparing for Installation): (Invoking guix refresh): (Invoking guix challenge): (Networking Services): "Alternatively", not "Alternately".
2020-05-20bootloader: grub: Allow booting from a Btrfs subvolume.Maxim Cournoyer
* gnu/bootloader/grub.scm (strip-mount-point): Remove procedure. (normalize-file): Add procedure. (grub-configuration-file): New BTRFS-SUBVOLUME-FILE-NAME parameter. When defined, prepend its value to the kernel and initrd file names, using the NORMALIZE-FILE procedure. Adjust the call to EYE-CANDY to pass the BTRFS-SUBVOLUME-FILE-NAME argument. Normalize the KEYMAP file as well. (eye-candy): Add a BTRFS-SUBVOLUME-FILE-NAME parameter, and use it, along with the NORMALIZE-FILE procedure, to normalize the FONT-FILE and IMAGE nested variables. Adjust doc. * gnu/bootloader/depthcharge.scm (depthcharge-configuration-file): Adapt. * gnu/bootloader/extlinux.scm (extlinux-configuration-file): Likewise. * gnu/system/file-systems.scm (btrfs-subvolume?) (btrfs-store-subvolume-file-name): New procedures. * gnu/system.scm (operating-system-bootcfg): Specify the Btrfs subvolume file name the store resides on to the `operating-system-bootcfg' procedure, using the new BTRFS-SUBVOLUME-FILE-NAME argument. * doc/guix.texi (File Systems): Add a Btrfs subsection to document the use of subvolumes. * gnu/tests/install.scm (%btrfs-root-on-subvolume-os) (%btrfs-root-on-subvolume-os-source) (%btrfs-root-on-subvolume-installation-script) (%test-btrfs-root-on-subvolume-os): New variables.