aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-04-20doc: Correct the "guix shell --container" example.Rostislav Svoboda
* doc/guix.texi (Invoking @command{guix shell}): Add missing parameters to preserve and expose $XAUTHORITY. Adjust corresponding textual description. Change-Id: Ib99c81c107ff9784708ae807ec9b3ab93ad75603 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2024-04-20doc: Update gnome-desktop-configuration.Liliana Marie Prikler
* doc/guix.texi (gnome-desktop-configuration): Fill in missing fields. [gnome]: Talk about the deprecation.
2024-04-19doc: Fix cross-references.Matthew Trzcinski
* doc/guix.texi (Setting Up the Daemon): Use @xref to start sentence. (Build Systems): Capitalize "python" and start parenthesized reference with @pxref. Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de> Change-Id: I3504d8668d137029f5f76f025108b7023d9b4182
2024-04-19Revert "maint: Generate 'doc/version.texi' reproducibly."Janneke Nieuwenhuizen
Using `build-aux/mdate-from-git.scm' makes this no longer necessary. This reverts commit e73ea7bd64f64709c71f89dfb111cf3e8ada3771. Change-Id: I29d1e36b13d255e5a65b7348e7ae4f2b2c24a518
2024-04-19Revert "maint: Generate 'doc/version-LANG.texi' reproducibly."Janneke Nieuwenhuizen
Using `build-aux/mdate-from-git.scm' makes this no longer necessary. This reverts commit 0e4ead187d83a958ca0deb54857c04967e84d68b. Change-Id: I9177828f90fa7f7e256bc72fdff35a2fab355780
2024-04-18system: Remove nss-certs from OS templates, adjust doc.Maxim Cournoyer
This is a follow-up to commit 86afaadb51 ("system: Add 'nss-certs' to %base-packages-networking.") * doc/guix-cookbook.texi (Running Guix on a Linode Server): Remove nss-certs from operating system's packages field. (Running Guix on a Kimsufi Server): Likewise. * doc/guix.texi (Using the Configuration System): Likewise. (X.509 Certificates): Adjust to mention nss-certs *is* part of %base-packages. * gnu/installer/services.scm (%system-services): Remove recommendation to install nss-certs. * gnu/system/examples/bare-bones.tmpl (host-name): Remove obsolete comments. * gnu/system/examples/desktop.tmpl (packages): Remove nss-certs. * gnu/system/examples/lightweight-desktop.tmpl (packages): Likewise. * gnu/system/examples/plasma.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64-nfs-root.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64.tmpl (packages): Likewise. * gnu/system/examples/vm-image.tmpl (packages): Likewise. * gnu/system/images/orangepi-r1-plus-lts-rk3328.scm (packages): Likewise. * gnu/system/images/pine64.scm (packages): Likewise. * gnu/system/install.scm (installation-os) [packages]: Likewise. Change-Id: If09123a69b987178bcb0aab61c4570c14fc1286f
2024-04-17doc: Expound on ‘guix-home-service-type’.Ludovic Courtès
* doc/guix.texi (Guix Home Service): Reword intro. Tweak example to be closer to reality. (Declaring the Home Environment): Link to ‘guix-home-service-type’. (Invoking guix home): Likewise. Change-Id: I0355a6da9b9a28818eb0738854381671a6a1f652
2024-04-17services: Add the Guix Home service.Richard Sent
This patch adds a Guix Home service, which allows for configuring/deploying an operating-system declaration with an associated home-environment. * gnu/services/guix.scm: Add guix-home-service and guix-home-shepherd-service * gnu/home/services/shepherd.scm: Don't attempt to launch user shepherd when the system shepherd runs guix-home-<user> * doc/guix.texi: Add documentation for guix-home-service * gnu/tests/guix.scm: Add a test to verify guix-home-service-type is able to activate a home environment Change-Id: Ifbcc0878d934aa4abe34bb2123b5081fb432aa8e Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-04-17guix: Add xtensa-ath9k-elf platform.Jean-Pierre De Jesus DIAZ
* Makefile.am (MODULES): Add guix/platforms/xtensa.scm. * guix/platforms/xtensa.scm (xtensa-ath9k-elf): New variable. * doc/guix.texi: Add xtensa-ath9k-elf documentation. Change-Id: I51eef245142ed58613340c16d4bf7266e6bf6adb Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-04-17doc: Add documentation for x86_64-linux-gnux32.Jean-Pierre De Jesus DIAZ
* doc/guix.texi: Add documentation for x86_64-linux-gnux32. Change-Id: I408d57ae5ae3e9b1449633b82c41aba0d40ded06 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-04-14maint: Ensure generated file reproducibility for dist.Janneke Nieuwenhuizen
* doc/local.mk (doc-clean): New target. (DIST_CONFIGURE_FLAGS): New variable. (auto-clean): Use them in new target. * Makefile.am (dist-doc-pot-update): Use it in new target. (dist): Change to depend on it to clean possibly stale files, instead of doc-pot-update directly. Add a toplevel check to ensure that Autotools cache is up to date. Change-Id: I2ff2d88db9fe1e708ab65e33e1f3d7ecee882cb4
2024-04-14maint: Reset CreationDate metadata on generated PDFs.Janneke Nieuwenhuizen
* doc/local.mk (.dot.pdf): Create PDF in UTC0 and reset CreationDate metadata. Change-Id: I3873ecdeec781c30874d53d032406cbe23922a25
2024-04-14maint: Avoid PNG and PDF generation to fail silently.Janneke Nieuwenhuizen
* doc/local.mk (.dot.png): Split single shell command into separate recipe lines, prefixed by $(AM_V_at). (.dot.pdf): Likewise. Change-Id: I41fb856bb73f947abd91361ed203132e939f3897
2024-04-14maint: Avoid EPS generation to fail silently, ensure reproducibility.Janneke Nieuwenhuizen
Currently, Graphviz' dot does not insert a %%CreationDate. ImageMagick's convert on PNG->EPS does insert a %%CreationDate but it respects SOURCE_DATE_EPOCH. * doc/local.mk (.png.eps): Split single shell command into separate recipe lines, prefixed by $(AM_V_at). (.dot.png): Likewise. Check that generated EPS file has no %%CreationDate. Change-Id: I5a03485c19c72f0c46411815c51290e52a8e5399
2024-04-14maint: Generate 'doc/version-LANG.texi' reproducibly.Janneke Nieuwenhuizen
* doc/local.mk ($(srcdir)/doc/stamp-vti): Change rule into... (version.texi-from-git): ...this new function. Call it with vti,guix.texi,; and for all MANUAL_LANGUAGES with $(i),po/doc/guix-manual.$(lang).po, -$(lang.po). Change-Id: Ia8df618178066cad320eecea0299337224e23a73
2024-04-14maint: Help help2man generate reproducible man-pages.Janneke Nieuwenhuizen
* doc/local.mk (SOURCE_DATE_EPOCH): New exported variable. Change-Id: I6636693695d5502657f1475d93d31949e0b0b39d
2024-04-14maint: Generate 'doc/version.texi' reproducibly.Timothy Sample
* doc/local.mk ($(srcdir)/doc/stamp-vti): New rule (overriding one provided by Automake). Co-authored-by: Janneke Nieuwenhuizen <janneke@gnu.org> Change-Id: If44965e9a3ecfb45865c58ee7a558951be8d15ae
2024-04-14doc: Use "dejavu sans" instead of "Helvetica" or "sans" in dot images.Janneke Nieuwenhuizen
Font-dejavu is (now) an input of fontconfig. Specifying "dejavu sans" makes generated images reproducible even when other fonts are installed (notably font-google-noto). * doc/images/bootstrap-graph.dot, doc/images/bootstrap-packages.dot, doc/images/coreutils-bag-graph.dot, doc/images/coreutils-graph.dot, doc/images/gcc-core-mesboot0-graph.dot, doc/images/service-graph.dot, doc/images/shepherd-graph.dot: Use fontname = "dejavu sans". * doc/guix.texi (Full-Source Bootstrap): Update gcc-core-mesboot0.dot recipe accordingly. Change-Id: If21d7d39d45c66de5bceafb7b825a057d540ee50
2024-04-14doc: Standardize IRC stylization.Matthew Trzcinski
* doc/guix.texi (After System Installation): Make references to Libera.Chat consistent. Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-04-12doc: Fix grammar and markup.Matthew Trzcinski
doc/guix.texi (Setting Up the Daemon): Remove comma and extra words. doc/guix.texi (Mail Services): Add definite article to setting. Use @samp markup on setting. Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de> Change-Id: I5b3ef115ec718454db4fc046ea5f77ba9fe50a37
2024-04-08gexp: Add #:guile parameter to ‘gexp->file’ and ‘scheme-file’.Ludovic Courtès
This brings ‘gexp->file’ in line with its documentation and mirrors what’s done for ‘gexp->script’ and ‘program-file’. Fixes <https://issues.guix.gnu.org/69401>. * guix/gexp.scm (gexp->file): Add #:guile, as was already documented. (<scheme-file>)[guile]: New field. (scheme-file): Add #:guile. (scheme-file-compiler): Honor ‘guile’ field. * tests/gexp.scm ("gexp->file") ("gexp->file + file-append", "gexp->file + #:splice?") ("gexp->file, cross-compilation") ("gexp->file, cross-compilation with default target") Add #:guile to ‘gexp->file’ calls. ("gexp-modules deletes duplicates") ("gexp->derivation & with-imported-module & computed module") ("gexp->derivation & with-extensions", "scheme-file"): Likewise for ‘scheme-file’ calls. Change-Id: I47536063d5e411e561ec321e535267e92dd06044 Reported-by: Efraim Flashner <efraim@flashner.co.il> Change-Id: I58d653c7fbe65c665bafcbd332ac9b264ddeab64
2024-04-07doc: Restore some of the old installation instructions.Florian Pelz
Follow-up to 227e0469dbfec7e47b57d824dcf45a04ac4026c9. * doc/guix.texi (Binary Installation): Revert wording for installing the Debian package. Restore how to reproduce the binary tarball. Restore how to uninstall. (copying): Add copyright notice for Matthew Trzcinski. Change-Id: Ib74199e39bd7a50ac58045f2bc47f61fc04eacb9
2024-04-06doc: Move "Running the Test Suite" after "Building from Git".Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Running the Test Suite" after "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-06doc: Move "Requirements" before "Building from Git"Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Requirements" before "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-06doc: Fix Texinfo menus.Maxim Cournoyer
There should be two spaces between the node name and its description. Found via 'M-x texinfo-all-menus-update' in Emacs. Change-Id: I2b17180746f8d97ea5f927b8a504419c087dd5f5
2024-04-06doc: Simplify installation instructionsMatthew Trzcinski
* doc/guix.texi (Installation): - Move the definition of "foreign distro" out of quotation - Repeat overwrite warning - Remove superfluous commentary * doc/guix.texi (Binary Installation): - Clarify that installing on a foreign distro has two methods: using packaged binaries and building from source - Add cross reference to "Building from Git" - Move the foreign distro installation instructions out of quotation - Move directions for 'guix-install.sh' after instructions to use distribution-specific package managers - Specify "distributions" as "GNU/Linux distributions" - Add GnuPG as a requirement for 'guix-install.sh' - Add comma after "Likewise" - Remove redundant instructions to use 'guix-install.sh' - Split the requirements between system requirements for binary installations, GNU/Linux or GNU/Hurd, and requirements for running 'guix-install.sh' - Clarify that 'guix-install.sh' guides users through the steps - Summarize the steps 'guix-install.sh' follows rather than try to detail them - Make explicit that the 'guix-install.sh' default is to download substitutes - Emphasize that the substitute authorization code is an example and may need modification Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-05gnu: guix: Define ‘guix-for-channels’ and document its use.Ludovic Courtès
* gnu/packages/package-management.scm (guix-for-channels): New procedure. * doc/guix.texi (Customizing the System-Wide Guix): New section. (Base Services): Add cross-reference. Change-Id: Ied51c3bf9bf08dfc629bb3f0a152eb20b869a636
2024-04-05build-system/channel: Add support for additional channels.Ludovic Courtès
Until now, ‘channel-build-system’ would assume a single channel, the ‘guix’ channel. This change lets users specify additional channels using the #:channels parameter. * guix/build-system/channel.scm (build-channels): Add #:channels and honor it. (channel-build-system): In ‘lower’, add #:channels and honor it. * doc/guix.texi (Build Systems): Document it. Change-Id: I36c1d19cbeee02a4d1144de089b78df0390774a0
2024-04-05guix-install.sh: Add ‘--uninstall’ flag.Ludovic Courtès
* etc/guix-install.sh (REQUIRE): Add groupdel and userdel. (chk_term): Handle ‘WAR’. (sys_delete_store, sys_delete_build_user, sys_delete_guix_daemon) (sys_delete_init_profile, sys_delete_user_profiles): New functions. (main): Rename to… (main_install): … this. (main_uninstall): New function. (main): Dispatch between these two. * doc/guix.texi (Installation): Refer to “Binary Installation” instead of repeating it. (Binary Installation): Document uninstallation. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I55b7c10823773bced2e268273e8ce828cb3bd98d
2024-04-05doc: Explain to run bootstrap after Automake errors.Florian Pelz
Fixes <https://issues.guix.gnu.org/70140>. Suggested by Rostislav Svoboda <rostislav.svoboda@gmail.com>. * doc/contributing.texi (Building from Git): Explain. * doc/guix.texi: Update copyright year. Change-Id: I0cedc60f9ece3ec78df60df54ffeacff545bfc63
2024-04-03Switch order of the default substitute servers.Christopher Baines
The aim here is to improve the user experience. There's anecdotal evidence that the network performance for bordeaux is better compared to ci at least for some users, and I don't know of any issues with rate limiting or access restriction for bordeaux compared to ci. It also has IPv6 support. Additionally, bordeaux generally had more substitutes than ci, particularly for aarch64-linux and armhf-linux. This change will offer a very slight speedup for those substitutes that only bordeaux has. Bordeaux has been a default substitute server for nearly 3 years now and I think this change is overdue. I'm also hopeful that we'll be able to build on the testing regarding mirrors for bordeaux, and that'll allow potentially improving the hosting setup (through providing more redundancy) and further improving substitute fetching for users who currently have issues with substitute access. * config-daemon.ac: Switch substitute urls order. * doc/guix.texi: Ditto. * etc/guix-install.sh: Ditto. * gnu/installer/newt/network.scm (wait-service-online): Ditto. * guix/store.scm (%default-substitute-urls): Ditto. Change-Id: I4f6d93ae1fc8b03d80b47b18b5749a51f1fde17b Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-04-03maint: Fix help2man for guix subcommands with `make V=2'.Janneke Nieuwenhuizen
* doc/local.mk ($(srcdir)/%D%/guix-%.1): Use AM_V_HELP2MAN and cater for make's `@' silencing at the start of the command. Change-Id: Id80c48f0d7697167fea64700a7fe140003732d28
2024-04-01nls: Update translations.Florian Pelz
* po/guix/ar.po: New file. * po/guix/LINGUAS: Add 'ar'. * po/doc/guix-cookbook.pt_BR.po: New file. * po/doc/local.mk: Add 'pt_BR' cookbook. * doc/local.mk: Add 'pt_BR' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'ko', 'pt_BR'. * doc/guix-cookbook.texi (Top): Mention 'ko', 'pt_BR' cookbook. Change-Id: Id1846ca100263b3fc1fa2ed52654c670270ee809
2024-03-31doc: cookbook: Fix typo.Maxim Cournoyer
* doc/guix-cookbook.texi (Network bridge for QEMU): Fix typo. Change-Id: I32f88bd85157a6b2cee9f68840f9e77101596518
2024-03-30Merge branch 'gnome-team'Liliana Marie Prikler
2024-03-30doc: Cross-reference virtual build machines from ‘guix time-machine’.Ludovic Courtès
* doc/guix.texi (Invoking guix time-machine): Tweak the note about packages that may fail to build. Add cross-reference to virtual build machines. Change-Id: Ib2a4a28cdca0c8970d0f5327e39b4a21800ea2e1
2024-03-30doc: ‘guix time-machine’ can travel to v0.16.0.Ludovic Courtès
This is a followup to a26bce55e60aa3444c4378d3996f3aa41b9661e9. * doc/guix.texi (Invoking guix time-machine): Update reference to oldest commit. Change-Id: Iae3d751d4377de92481276f9f2f31128f85c23c4
2024-03-25services: nar-herder: Add new configuration options.Christopher Baines
* gnu/services/guix.scm (nar-herder-configuration-new-ttl, nar-herder-cached-compression-configuration-unused-removal-duration, nar-herder-cached-compression-configuration-ttl, nar-herder-cached-compression-configuration-new-ttl): New procedure. (nar-herder-shepherd-services): Handle the new options. * doc/guix.texi (Guix Services): Document the new nar-herder options. Change-Id: I161e490221a3ce394e32ada685dca27df60638bb
2024-03-22doc: Mention channel files beyond ~/.config/guix.Ludovic Courtès
* doc/guix.texi (Channels): Instead of mentioning just ~/.config/guix/channels.scm, mention channel files in general and link to “Invoking guix pull”. Change-Id: Iefb8a2d5ee5d804b2b6319785842fc3a97704495
2024-03-22services: guix: Add ‘channels’ field.Antero Mejr
* doc/guix.texi (Base Services): Document 'guix-configuration-channels' field. (Invoking guix pull): Add cross-reference. * gnu/services/base.scm (install-channels-file): New procedure. (guix-configuration): Add channels field. (guix-activation): Use 'install-channels-file' procedure. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I4d89235bf0bc6dde69984138ccb894b48ace9d76
2024-03-21doc: Add “Source Tree Structure” section.Ludovic Courtès
* doc/contributing.texi (Source Tree Structure): New node. * doc/guix.texi (Programming Interface): Add cross-reference. Change-Id: I141a1f4d806ae5f72c7a246e18c14dc63056a607
2024-03-21doc: Update ‘block-facebook-hosts-service-type’ description.Ludovic Courtès
This is a followup to c1d37d0653766c8de52e22bae01701baf503338f. * doc/guix.texi (Networking Services): Update to mention unroutable addresses. Change-Id: I6f62e1f414a3eb7892b2d4cc0d011458bbec7001
2024-03-20Merge remote-tracking branch 'savannah/master' into gnome-teamChristopher Baines
Change-Id: Iec8e15b79c6fde516294c2bfcaf8ee3575b1f745
2024-03-19doc: cookbook: Account for ‘guix pull’ in /etc/profile instructions.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up Compute Nodes): Include $HOME/.config/guix/current. Change-Id: I6c1c42394991af8f1fa7c2630bdb4b0aef946c2b
2024-03-19git authenticate: Document ‘--end’.Ludovic Courtès
* guix/scripts/git/authenticate.scm (show-help): Document ‘--end’. * doc/guix.texi (Invoking guix git authenticate): Likewise. Reported-by: Tomas Volf <~@wolfsden.cz> Change-Id: Ia646203ce2f721487de547c76b9488754c70db66
2024-03-19doc: Adjust for QEMU info manual name change.Maxim Cournoyer
* doc/guix.texi (Networking Setup): Change QEMU to qemu for its info manual reference. Change-Id: I55f57e66947f2581531c15fd5228a3ca043a9574
2024-03-17gnu: services: Add insecure-sasl-mechanisms to prosody configuration.Carlo Zancanaro
* gnu/services/messaging.scm (prosody-configuration): Add insecure-sasl-mechanisms configuration option. * doc/guix.texi (Messaging Services): Document it. Change-Id: I8d9e42476ea8ad2f89b143ed4a66b4798e418586 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2024-03-16doc: Correct the "guix package --install-from-expression" example.Rostislav Svoboda
* doc/guix.texi (Invoking @command{guix package}): Correct the module where 'guile-final' is defined. It is actually located in (gnu packages commencement) rather than in the (gnu packages base). Change-Id: I7747106916d53dcbe296b7302983c5013eb2926d Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-03-16Merge remote-tracking branch 'savannah/master' into gnome-teamChristopher Baines
Change-Id: I775274c2693536e2efa36c9abca4c54c5c458e26
2024-03-15doc: build: Update paths to style sheets.Luis Felipe
The Guix website style sheets are now organized in themes. This change makes the documentation builder use the resources provided by a theme called "initial" (See https://issues.guix.gnu.org/69783). * doc/build.scm (syntax-highlighted-html): Update path to CSS. (html-manual-indexes): Likewise. (stylized-html): Likewise, and update path to language picker image. Change-Id: Ib2d51fcfdec42ad827add1ead1cfee4c9c4e65b7 Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
generated by cgit