summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2026-01-19doc: Use versioned manual URLs.version-1.4.0Rutherther2-4/+6
* doc/build.scm (stylized-html): Move to versioned manual URL. (html-manual): Use versioned manual URL. * doc/htmlxref.cnf (GUIX): Add /1.4.0. Change-Id: I82048a9548894e335e7c2427a739733304a7961a Co-authored-by: Ludovic Courtès <ludo@gnu.org> Fixes: #5681
2025-07-09doc: Fix URL of ‘language-picker.svg’.Ludovic Courtès1-2/+2
Fixes a regression introduced in 824d46a2fee18111a2a80f7805404a1ea58134c7. * doc/build.scm (stylized-html)[build]: Avoid double leading slash for ‘language-picker.svg’. Change-Id: I0817949862f061dbbe04352bda1e479347015c84
2025-07-09doc: Add links to versions and variants as a drop-down menu.Ludovic Courtès1-5/+70
* doc/build.scm (%latest-guix-version): New variable. (stylized-html): Add #:latest-version. [build](menu-item-separator): New variable. (version-menu-items, input-file-language): New procedures. (stylized-html, process-html): Add ‘language’ parameter. Update callers. Change-Id: If7cea2410802eec5af1d3c0407d5569250eb15ef
2025-07-09doc: Really honor ‘GUIX_WEB_SITE_URL’.Ludovic Courtès1-2/+3
This is useful when testing changes locally, so that CSS links point to the right place. * doc/build.scm (%web-site-url): Default to /. (%manual-css-url): Honor ‘%web-site-url’. Change-Id: I8d885eba0fb8560dd7da7f21629c716a06c16b1f
2025-06-16doc: Update build machinery for today’s ‘master’.Ludovic Courtès1-3/+3
This updates TeX Live package names to match what’s available in today’s ‘master’ branch since ‘master’ is what is used to build the on-line copy of the manual. * doc/build.scm (pdf-manual)[texinfo-profile]: Update TeX Live package names. Change-Id: I5db327e1543a1f9a8697bf3b1b65ab50959efdc4
2025-06-16doc: Use CSS from guix.gnu.org.Ludovic Courtès1-3/+7
This is a followup to commit 7bbc00ccf0315a68509cacd6a85e1ae8ae7f5e5d of guix/artwork.git. * doc/build.scm (%manual-css-url): New variable. (%makeinfo-html-options): Use it instead of www.gnu.org/…/manual.css. (stylized-html): Likewise for the default #:manual-css-url. Change-Id: I20bd3866383f8cbb4984993c15dbab483a17f6c9
2025-06-16doc: build.scm: Handle (current-source-directory) being #f.Christopher Baines1-2/+5
Since this seems to be the case when the devel manual is being built on bayfront. * doc/build.scm: Use the current working directory as a fallback if (current-source-directory) is #f, and log the value of root. Change-Id: Ic43fd05a4a0822d9efb935069850f0a8cadd80aa
2025-04-09doc: Change ‘guix-install.sh’ URL to https://guix.gnu.org/install.sh.Ludovic Courtès1-4/+4
This is a followup to 47d554602c34a15c24efbc87e3bc2806f9f68055, as proposed in <https://lists.gnu.org/archive/html/guix-devel/2025-01/msg00167.html>. * doc/guix.texi (Installation, Binary Installation): Change URL for installation script. Add ‘-O guix-install.sh’ to wget command line. Change-Id: I83702cacc3bdf8d15d3972d2de17e1ce8607ed52
2025-03-12doc: Use the correct patch submission email address.Leo Famulari1-1/+1
Reported by sleep_walker on #guix. * doc/contributing.texi (Sending a Patch Series): Fix the email address in the example. Change-Id: If81243f9f23128a62201a77d328c158de94a4683 Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2025-01-21doc: Add missing quotes in wget command for ‘guix-install.sh’.Ludovic Courtès1-1/+1
* doc/guix.texi (Binary Installation): Add missing quotes in wget command. Change-Id: I4ebb50492070c298ccc4f02e62d90e875ffe44da
2025-01-21doc: Change ‘guix-install.sh’ URL to gitweb.Ludovic Courtès1-3/+3
The cgit interface at Savannah has been taken down. * doc/guix.texi (Installation): Change ‘guix-install.sh’ URL to gitweb. Change-Id: I45274bdb7713d16bafe2d0b464865362bddcf303
2024-09-05doc: build: Handle when guile source is packed with zstd.Florian Pelz1-0/+1
* doc/build.scm (guile-manual): Also include zstd in PATH. Change-Id: Iff49825fe84121bff777ed45c03fb14af0a0e719
2024-07-26doc: Repair building non-English website manuals.Ludovic Courtès1-3/+112
Fixes: <https://issues.guix.gnu.org/72257>. * doc/build.scm (translated-texi-manuals): Copy the code from (@ (guix self) translate-texi-manuals) rather than importing it. This fixes building doc/build.scm at version 1.4.0 with recent Guix revisions. Change-Id: Ia23425f824e4a6e619f32a28493b811c0e7c31d5 Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2023-06-08doc: Adjust HTML patterns to correctly process Texinfo 6.8 output.Ludovic Courtès1-4/+13
Prior to ceb5ef8347ae0e3015296f5c169ab903bac526a8, (@ (gnu packages texinfo) texinfo), which is what is used here, was pointing to version 6.7. * doc/build.scm (html-manual-identifier-index)[build](worthy-entry?): Adjust patterns for Texinfo 6.8. (syntax-highlighted-html)[build](syntax-highlight): Likewise.
2022-12-18doc: Update URLs for the manual and cookbook translations.v1.4.0Ludovic Courtès1-3/+7
* doc/htmlxref.cnf: Update URLs for "guix" and "guix-cookbook".
2022-12-18doc: Add guile-netlink to 'htmlxref.cnf'.Ludovic Courtès1-1/+3
* doc/htmlxref.cnf: Add guile-netlink.
2022-12-15doc: Use VM image file name consistently.Ludovic Courtès1-3/+4
Previously, what "/tmp/qemu-image" refers to could be unclear at first. * doc/guix.texi (Running Guix in a VM): Use the original image file name instead of /tmp/qemu-image. * po/doc/guix-manual.de.po, po/doc/guix-manual.es.po, po/doc/guix-manual.fr.po, po/doc/guix-manual.pt_BR.po, po/doc/guix-manual.ru.po, po/doc/guix-manual.zh_CN.po: Adjust accordingly.
2022-12-14doc: Fix formatting for 'computed-file'.Bruno Victal1-2/+1
* doc/guix.texi (G-Expressions): Fix formatting for 'computed-file'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-14doc: Verify the release with my own OpenPGP key.Ludovic Courtès1-2/+2
* doc/guix.texi (OPENPGP-SIGNING-KEY-ID, OPENPGP-SIGNING-KEY-URL): Switch to my key.
2022-12-08doc: Recommend 'match-record'.Ludovic Courtès1-1/+6
* doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'.
2022-11-27doc: cookbook: Fix commands in example.Florian Pelz1-2/+2
Fixes <https://issues.guix.gnu.org/59463>. Reported by Luca Cirrottola <luca.cirrottola@inria.fr>. * doc/guix-cookbook.texi (Reproducible profiles): Make it work.
2022-11-24doc: Add a security keys section to the cookbook.Maxim Cournoyer1-0/+62
* doc/guix-cookbook.texi (Top): Register new menu. (System Configuration): Likewise. (Using security keys): New section.
2022-11-20doc: Note that ‘guix package’ accepts file names.Tobias Geerinckx-Rice1-7/+13
* doc/guix.texi (Package Management)[Invoking guix package]: Mention support for operating on store file names. Co-authored-by: Tobias Geerinckx-Rice <me@tobias.gr>
2022-11-23offload: Increase default 'overload-threshold' value.Ludovic Courtès1-1/+1
When offloading to a single machine, the previous default value would lead 'guix offload' to wait possibly for several minutes between subsequent builds until normalized load would finally go below 0.6. Increasing it mitigates that. * guix/scripts/offload.scm (<build-machine>)[overload-threshold]: Bump to 0.8. * doc/guix.texi (Daemon Offload Setup): Likewise.
2022-11-22doc: Call out potential for security vulnerabilities in old software.pelzflorian (Florian Pelz)1-1/+10
* doc/guix.texi (Invoking guix time-machine): Add a note. Co-authored by: Simon Tournier <zimon.toutoune@gmail.com>
2022-11-21guix: modify-input: Recommend prepend instead of append.Vivien Kraus1-6/+6
* doc/guix.texi (Defining Package Variants): Document the "prepend" clause of modify-inputs first. * guix/packages.scm (modify-inputs): use "prepend" in the docstring. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-19doc: Build more man pages.Hilton Chain1-0/+12
* doc/local.mk (sub_commands_mans): Add guix-container.1, guix-copy.1, guix-describe.1, guix-git.1, guix-graph.1, guix-home.1, guix-offload.1, guix-pack.1, guix-processes.1, guix-repl.1, guix-shell.1, guix-style.1. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-18services: Add Shepherd 'configuration' action to various services.Ludovic Courtès1-0/+11
* gnu/services/avahi.scm (avahi-shepherd-service): Add 'actions' field. * gnu/services/base.scm (nscd-actions): Add call to 'shepherd-configuration-action'. * gnu/services/desktop.scm (upower-shepherd-service): Add 'actions' field. (elogind-shepherd-service): Likewise. * gnu/services/dict.scm (dicod-shepherd-service): Likewise. * gnu/services/networking.scm (openntpd-shepherd-service): Likewise. (tor-shepherd-service): Likewise. * gnu/services/ssh.scm (openssh-shepherd-service): Likewise. * gnu/services/web.scm (nginx-shepherd-service): Likewise. * gnu/services/xorg.scm (gdm-shepherd-service): Likewise. * gnu/tests/base.scm (run-basic-test)["nscd configuration action"]: New test. * doc/guix.texi (Services): Document it.
2022-11-18services: shepherd: Define 'shepherd-configuration-action' helper.Ludovic Courtès1-0/+33
* gnu/services/shepherd.scm (shepherd-configuration-action): New * doc/guix.texi (Shepherd Services): Document it.
2022-11-18linux-initrd: raw-initrd: Add keyword argument #:pre-mount.Hilton Chain1-3/+5
* gnu/system/linux-initrd.scm (raw-initrd): Add keyword argument #:pre-mount. Document it. * doc/guix.texi (initial RAM disk): Likewise. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-17Revert "services: configuration: Revert to a working ‘guix home’."Maxim Cournoyer1-9/+36
This reverts commit 39e4e00f75be8055300cb0afffb8bd4b4d35f2cc, with fixes for the guix home issues reported and another one found while reconfiguring berlin in the subsequent commit.
2022-11-13services: configuration: Revert to a working ‘guix home’.Tobias Geerinckx-Rice1-36/+9
This reverts commit 543d971ed2a1d9eb934af1f51930741d7cc4e7ef, and its dependent commit 9b21cd2e9a614f1937769caf3917a791b151d841, which appear to have triggered a recent wave of ‘guix home’ regressions involving (services (list (service home-bash-service-type))): In gnu/home/services/shells.scm: 504:7 3 (home-bash-extensions #<<home-bash-configuration> package: #<package bash@5.1.8 gnu/packages/ba…> …) In unknown file: 2 (append #<<location> file: "…" line: 14 column: 12> ()) In ice-9/boot-9.scm: 1685:16 1 (raise-exception _ #:continuable? _) 1685:16 0 (raise-exception _ #:continuable? _) ice-9/boot-9.scm:1685:16: In procedure raise-exception: In procedure append: Wrong type argument in position 1 (expecting empty list): #<<location> file: "…" line: 14 column: 12> I should love to dive in & fix this rather than revert, but urgently need sleep.
2022-11-15services: mcron: Add log? and log-format fields to mcron-configuration.Maxim Cournoyer1-9/+36
* gnu/services/mcron.scm (list-of-gexps?): New predicate. (mcron-configuration): Rewrite using define-configuration. [log?, log-format]: New fields. (mcron-shepherd-services): Invoke mcron with the --log and --log-format arguments when log? is #t, (generate-doc): New procedure. * doc/guix.texi (Scheduled Job Execution): Update doc. (Mcron Home Service): Likewise. * gnu/home/services/mcron.scm: Keep in sync with the above changes to gnu/services/mcron.scm.
2022-11-15guix: shell: Add '--symlink' option.Maxim Cournoyer1-1/+8
* guix/scripts/pack.scm (%options): Extract symlink parsing logic to... (symlink-spec-option-parser): ... here. (self-contained-tarball/builder): Add a comment mentioning why a relative file name is used for the link target. * guix/scripts/environment.scm (show-environment-options-help): Document new --symlink option. (%default-options): Add default value for symlinks. (%options): Register new symlink option. (launch-environment/container): Add #:symlinks argument and extend doc, and create symlinks using evaluate-populate-directive. (guix-environment*): Pass symlinks arguments to launch-environment/container. * doc/guix.texi (Invoking guix shell): Document it. * tests/guix-shell.sh: Add a --symlink (negative) test. * tests/guix-environment-container.sh: Add tests.
2022-11-15doc: Add missing closing parentheses in examples.Ludovic Courtès1-2/+3
* doc/guix.texi (VNC Services, Guix Home Services): Add missing closing parentheses.
2022-11-15doc: Link to the Git book instead of the git-scm.com homepage.pelzflorian (Florian Pelz)1-1/+1
The Pro Git book, unlike the git-scm.com homepage, is translated to many languages. Therefore translators of the Guix Manual can point to the appropriate translation now. * doc/guix.texi (Invoking guix pull): Point to the Pro Git book's URL. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-15doc: Build pt_BR manual.Ludovic Courtès1-1/+1
* doc/build.scm (%manual-languages): Add "pt_BR".
2022-11-15doc: Refer to the pt_BR translation.pelzflorian (Florian Pelz)1-2/+3
* doc/guix.texi (Top): Mention Brazilian Portuguese. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-15installer: Report known-unsupported PCI devices.Ludovic Courtès1-0/+3
* gnu/installer/hardware.scm: New file. * gnu/local.mk (INSTALLER_MODULES): Add it. * po/guix/POTFILES.in: Add it. * gnu/installer.scm (installer-steps): Pass #:pci-database to the 'welcome' step procedure. * gnu/installer/newt.scm (welcome-page): Add #:pci-database and pass it to 'run-welcome-page'. * gnu/installer/newt/welcome.scm (check-hardware-support): Add #:pci-database. Enumerate unsupported PCI devices and run an error page when unsupported devices are found. (run-welcome-page): Add #:pci-database and pass it to 'check-hardware-support' and to the recursive call. * gnu/installer/record.scm (<installer>)[welcome-page]: Adjust comment. * doc/guix.texi (Hardware Considerations): Mention it.
2022-11-07services: gitolite: Add local-code configuration option.Alexey Abramov1-0/+9
* gnu/services/version-control.scm (gitolite-rc-file): Add local-code field. (gitolite-rc-file-compiler): Serialize the field. * doc/guix.texi: Document it. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-06guix gc: Add '--vacuum-database'.Efraim Flashner1-0/+12
* guix/scripts/gc.scm (show-help, %options): Add '--vacuum-database'. * guix/store/database.scm (vacuum-database): New procedure. * doc/guix.texi (Invoking guix gc): Document the option.
2022-11-06doc: cookbook: Add section on MPD with bluealsa.Ricardo Wurmus1-0/+191
* doc/guix-cookbook.texi (Music Server with Bluetooth Audio): New section under System Configuration.
2022-11-06doc: cookbook: Update detailed menu for "System Configuration".Ricardo Wurmus1-2/+9
* doc/guix-cookbook.texi: Update menu.
2022-11-03services: ganeti: OS variants can be a directory.Marius Bakke1-6/+24
* gnu/services/ganeti.scm (<ganeti-os>)[extension]: Default to #f. (ganeti-os->directory): Only add extension if set. Support a file-like object for VARIANTS. * doc/guix.texi (Virtualization Services): Document this change and add example. Update Ganeti URLs while at it.
2022-11-03doc: Change example for special-files-service-type.EuAndreh1-3/+5
Also update the default value given in the docs. Change the example since the base system includes /usr/bin/env by default. * doc/guix.texi (Base Services): Change the example for special-files-service-type and update default. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-01doc: contributing: Use proper subsections.(1-4/+4
* doc/contributing.texi ("Submitting Patches") ["Sending a Patch Series", "Teams"]: Convert to numbered subsections. Add nodes. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2022-10-28doc: contributing: Expand "Sending a Patch Series".(1-37/+136
* doc/contributing.texi: Expand on sending patches and using git send-email. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2022-10-27build-system/pyproject: Always run tests verbosely for supported backends.Marius Bakke1-2/+3
* guix/build-system/pyproject.scm (pyproject-build): Default to '() instead of #false for TEST-FLAGS. * guix/build/pyproject-build-system.scm (check): Unconditionally enable verbose test flags. * doc/guix.texi (Build Systems): Document this change. * gnu/packages/fontutils.scm (python-glyphslib)[arguments]: Remove verbosity from #:test-flags. * gnu/packages/pdf.scm (python-pydyf, weasyprint)[arguments]: Likewise. * gnu/packages/python-web.scm (python-openapi-spec-validator)[arguments]: Likewise. * gnu/packages/python-xyz.scm (python-path, python-tempora)[arguments]: Likewise.
2022-10-27build-system: Add pyproject-build-system.Lars-Dominik Braun2-8/+57
This is an experimental build system based on python-build-system that implements PEP 517-compliant builds. * doc/guix.texi (Build Systems): Add pyproject-build-system section. * doc/contributing.texi (Python Modules): Mention pyproject.toml and the PYTHON-TOOLCHAIN package, as well as differences to python-build-system. * guix/build-system/pyproject.scm, guix/build/pyproject-build-system.scm, gnu/packages/aux-files/python/sanity-check-next.py, gnu/packages/python-commencement.scm: New files. * Makefile.am (MODULES): Register the new build systems. * gnu/local.mk (GNU_SYSTEM_MODULES): Add python-commencement.scm. * gnu/packages/python.scm (python-sans-pip, python-sans-pip-wrapper): New variables. Co-authored-by: Marius Bakke <marius@gnu.org>
2022-10-24gnu: version-control: Add make-gitolite procedure.David Thompson1-1/+15
* gnu/packages/version-control.scm (make-gitolite): New procedure. (gitolite): Use make-gitolite. * doc/guix.texi (Gitolite service): Document how to use make-gitolite.
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 09:33:22 +0000