summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-07-02doc: Fix some cgit-configuration typos(?).Tobias Geerinckx-Rice
* doc/guix.texi (Version Control Services): Fix lost ‘cgit-repo’s.
2023-07-07doc: Fix typo in screen-locker-service swaylock example.Arvid Krein
* doc/guix.texi (X Window): Reference swaylock instead of xlockmore. Signed-off-by: Josselin Poiret <dev@jpoiret.xyz>
2023-07-05home: Add inputrc service.Efraim Flashner
* gnu/home/services/shells.scm (home-inputrc-service-type, home-inputrc-configuration): New variables. (serialize-inputrc-key-bindings, serialize-inputrc-variables, serialize-inputrc-conditional-constructs, serialize-inputrc-extra-content): New procedures. * doc/guix.texi (Shells Home Services): Document it.
2023-06-24doc: Turn "Creating a Channel" into a step-by-step guide.Ludovic Courtès
* doc/guix.texi (Creating a Channel): Rewrite as a step-by-step guide. Move warning below and shorten it.
2023-06-18Add 'guix locate'.Ludovic Courtès
* guix/scripts/locate.scm, tests/guix-locate.sh: New files. * Makefile.am (MODULES): Add 'guix/scripts/locate.scm'. (SH_TESTS): Add 'tests/guix-locate.sh'. * po/guix/POTFILES.in: Add it. * doc/guix.texi (Invoking guix locate): New node. Co-authored-by: Antoine R. Dumont <antoine.romain.dumont@gmail.com>
2023-06-18doc: Fix typo.Ludovic Courtès
* doc/guix.texi (Invoking guix pack): Use @command, not @var.
2023-06-14home: services: ssh: Allow unset boolean options in ssh-config.Efraim Flashner
From man 5 ssh_config: Unless noted otherwise, for each parameter, the first obtained value will be used. We want to allow falling through to the first explicitly chosen user defined value. * gnu/home/services.ssh.scm (define-maybe boolean): New configuration. (openssh-host)[forward-x11?, forward-x11-trusted?, forward-agent?, compression?]: Replace default value with maybe-boolean. * doc/guix.texi (Secure Shell): Update documentation to match the changes in the code.
2023-06-12doc: Move and rewrite the branching strategy.Christopher Baines
Move away from using staging and core-updates, and make the strategy independant of branch names. Keep the 300 dependent threshold for changes to master, as I don't have any specific reason to change this. Most importantly, require using guix-patches issues to coordinate merging of the branches, as I think that'll address the key issues that have shown up recently where it's been unclear which branch should be merged next. * doc/contributing.texi (Submitting Patches): Move the branching strategy to a new Managing Patches and Branches section. (Managing Patches and Branches): New section. (Commit Policy): Simplify through referencing the new Managing Patches and Branches section. Signed-off-by: Christopher Baines <mail@cbaines.net>
2023-06-09home: services: ssh: Add 'match-criteria' option.Nicolas Graves
* gnu/home/services/ssh.scm (serialize-address-family): Raise '&formatted-message' instead of '&error'. (ssh-match-keywords): New variable. (match-criteria?): New procedure. (match-criteria): New maybe type. (openssh-host)[name]: Turn into 'maybe-string'. [match-criteria]: New field. (serialize-openssh-host): Adjust accordingly. * doc/guix.texi (Secure Shell): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-06-09home: services: ssh: Add 'add-keys-to-agent' field.Nicolas Graves
* gnu/home/services/ssh.scm (<home-openssh-configuration>)[add-keys-to-agent]: New field. (serialize-add-keys-to-agent): New procedure. (openssh-configuration->string): Use it. * doc/guix.texi (Secure Shell): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-06-08doc: Use the term "Procedure" for definitions.Ludovic Courtès
In an effort to homogenize things, commit 3c40dfe2851dd4ef48d2711f9f3531c06afbe1f2 replaced: @deffn {Scheme Procedure} with: @defun However, the latter prints "Function" when all existing material about Scheme uses the term "procedure". Thus, for consistency, this commit switches to: @deffn {Procedure} * doc/guix.texi, doc/contributing.texi: Use "@deffn {Procedure}" consistently rather than "@defun" or similar.
2023-06-08doc: Update outdated URL for Eudev wiki.Felix Lechner
Change was coordinated with upstream maintainer Boian Bonev. * doc/guix.texi: Update outdated URL for Eudev wiki. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-06-08doc: Replace reference to non-existing (gnu home services ssh-agent).Felix Lechner
Thanks to Alexandros Prekates and Markku Korkeala for pointing out the bug in the documentation. [1] [1] https://lists.gnu.org/archive/html/help-guix/2023-05/msg00220.html * doc/gnu.texi (Secure Shell): Replace reference to non-existing (gnu home services ssh-agent) Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-06-06doc: Add missing node to the main menu.Ludovic Courtès
This is a followup to 110462bb2f1678fb0147a5845b2b48d0566ce0b4. * doc/guix.texi (Top): Add "Mail Home Services" to the menu.
2023-06-05doc: Fix some typos in the manual.Efraim Flashner
* doc/guix.texi (Invoking guix pull): Correct followings to following. (Using Guix Interactively): Correct expresssion to expression. (Base Services): Correct overriden to overridden. (Audio Services): Correct Supress to Suppress. (Setuid Programs): Correct goup to group. (Essential Home Services): Correct apropiate to appropriate, similiar to similar. (Messaging Home Services): Correct seperately to separately. (image Reference): Correct instanciated to instantiated. (Full-Source Bootstrap): Correct udpate to update, Frome to From.
2023-06-05doc: cookbook: Update example my-libgit2 package.Efraim Flashner
* doc/guix-cookbook.texi (Packaging Tutorial): Improve the code quality of the example my-libgit2 package.
2023-06-04build-system: New agda-build-system.Josselin Poiret
* guix/build-system/agda.scm: New file. * guix/build/agda-build-system.scm: New file. * Makefile.am (MODULES): Register them. * doc/guix.texi (Build Systems): Add documentation for agda-build-system.
2023-06-04services: screen-locker-service-type: Configurable PAM and setuid.muradm
screen-locker-service-type by default does both define PAM entry and make program setuid binary. Normally both methods are mutually exclusive, if binary has setuid set it does not really needs PAM, otherway around also similar, if PAM is enabled binary should not relay on setuid. Recent swaylock package now compiled with PAM support. When PAM support is compiled in, swaylock rejects executing if binary is also setuid program. This change turns screen-locker-configuration from strict PAM AND setuid to more flexible PAM AND/OR setuid. Allowing swaylock to be configured properly while supporting other screen locker preferences. * gnu/services/xorg.scm (screen-locker-configuration): Switch from define-record-type to define-configuration. [using-pam?]: New field to control PAM entry existence. [using-setuid?]: New field to control setuid binary existence. (screen-locker-pam-services): Should not make unix-pam-service if using-pam? is set to #f. (screen-locker-setuid-programs): Should not make program setuid program if using-setuid? is set to #f. (screen-locker-generate-doc): Internal function to generate configuration documentation. (screen-locker-service): Adapt to new screen-locker-configuration. * gnu/services/desktop.scm (desktop-services-for-system): Adapt to new screen-locker-configuration. * doc/guix.texi: Reflect new changes to screen-locker-configuration. Signed-off-by: Josselin Poiret <dev@jpoiret.xyz>
2023-05-31upstream: Honor package properties for ignored and extra inputs.Ludovic Courtès
* guix/upstream.scm (update-package-inputs)[filtered-inputs] [regular-inputs, native-inputs, propagated-inputs]: New procedures. Use them in 'update-field' calls. * tests/guix-refresh.sh (GUIX_TEST_UPDATER_TARGETS): Add "libreoffice" to the dependencies of "the-test-package". Add 'updater-ignored-inputs' property to "the-test-package". * doc/guix.texi (Invoking guix refresh): Document it.
2023-05-31upstream: 'update-package-source' edits input fields.Ludovic Courtès
Previously, 'guix refresh r-ggplot2 -u' and similar commands would print of list of input changes that would have to be made manually. With this change, 'guix refresh -u' takes care of updating input fields automatically. * guix/upstream.scm (update-package-inputs): New procedure. (update-package-source): Call it when 'upstream-source-inputs' returns true. * guix/scripts/refresh.scm (update-package): Remove iteration over the result of 'changed-inputs'. * guix/import/test.scm (available-updates): Add support for input lists. * tests/guix-refresh.sh (GUIX_TEST_UPDATER_TARGETS): Add input list for "the-test-package". Make sure 'guix refresh -u' updates 'inputs' accordingly. * doc/guix.texi (Invoking guix refresh): Mention it.
2023-05-31doc: Mention 'guix refresh -u' for third-party channels.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Show how to run 'guix refresh -u' on a third-party channel.
2023-05-31nls: Update translations.Florian Pelz
* doc/guix-cookbook.texi (Top): Mention Slovak.
2023-05-30doc: Quote all list values.Florian Pelz
* doc/guix.texi (System Configuration)[Services]: Replace all () by '(), and similar quotings. (Home Configuration)[Home Services]: Likewise.
2023-05-30home: services: Add msmtp service.Tanguy Le Carrour
* gnu/home/services/mail.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Mail Home Services): New node. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2023-05-30doc: Update references to the Shepherd manual.Ludovic Courtès
* doc/guix.texi (Shepherd Services): Update cross-references to shepherd.info nodes removed in 0.10.0.
2023-05-25doc: Adjust HTML patterns to correctly process Texinfo 6.8 output.Ludovic Courtès
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.
2023-05-25doc: Tweak SELinux instructions.Ludovic Courtès
* doc/guix.texi (SELinux Support): Add note about 'guix-install.sh'. Provide the absolute file name of 'guix-daemon.cil'. Wrap important commands in @example. Suggest relabeling just /gnu and /var/guix instead of all of /. Add "systemctl restart guix-daemon".
2023-05-24doc: guix.texi: Add Texinfo line breaks.Felix Lechner
Adds two line breaks to the copyright block. The same kind of breaks [1] are present in the remaining fifty-five entries. [1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Line-Breaks * doc (guix.texi): Add Texinfo line breaks. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-24doc: contributing.texi: Specify recipient via equal sign in 'git send-email ↵Felix Lechner
--to'. The documentation for git send-email recommends the use of an equal sign when specifying a recipient with the --to option. [1] Adjusts the reference manual accordingly. [1] https://git-scm.com/docs/git-send-email * doc (contributing.texi): Specify recipient via equal sign in 'git send-email --to'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-24home: services: ssh: Do not empty ~/.ssh/authorized_keys by default.Janneke Nieuwenhuizen
The default was an empty list which would remove any ~/.ssh/authorized_keys file and replace it with a symlink to an empty file. On some systems, notably Ubuntu 22.10, the guix home generated ~/.ssh/authorized_keys file does not allow login. * doc/guix.texi (Secure Shell): Update, describe default #false value. * gnu/home/services/ssh.scm (<home-openssh-configuration>) [authorized-keys]: Change default to #f. (openssh-configuration-files): Cater for default #f value: Do not register "authorized_keys".
2023-05-21doc: Clarify instructions for hibernation on a swap file.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/62711>. * doc/guix.texi (Swap Space): Change 'resume' argument to a device in example; add comments. Update sentence describing 'resume' and 'resume_offset'.
2023-05-18style: Add 'arguments' styling rule.Ludovic Courtès
* guix/scripts/style.scm (unquote->ungexp, gexpify-argument-value) (quote-argument-value, gexpify-argument-tail) (gexpify-package-arguments): New procedures. (%gexp-keywords): New variable. (%options): Add "arguments" case for 'styling-procedure. (show-stylings): Update. * tests/style.scm ("gexpify arguments, already gexpified") ("gexpify arguments, non-gexp arguments, margin comment") ("gexpify arguments, phases and flags") ("gexpify arguments, append arguments") ("gexpify arguments, substitute-keyword-arguments") ("gexpify arguments, append substitute-keyword-arguments"): New tests. * doc/guix.texi (package Reference): For 'arguments', add compatibility note and link to 'guix style'. (Invoking guix style): Document the 'arguments' styling rule.
2023-05-18doc: Change '--with-configure-flag' example to something that works.Ludovic Courtès
Passing '-DBUILD_COMPLEX=OFF' to lapack would eventually lead to a link error. Reported by Florian Pelz <pelzflorian@pelzflorian.de>. * doc/guix.texi (Package Transformation Options): Change '--with-configure-flag' example. * etc/news.scm: Likewise.
2023-05-13services: nar-herder: Support extra environment vars.Christopher Baines
* gnu/services/guix.scm (nar-herder-configuration-extra-environment-variables): New procedure. (nar-herder-shepherd-services): Pass the environment variables to the shepherd. * doc/guix.texi (Guix Services): Document it.
2023-05-11services: Add vnstat-service-type.Bruno Victal
* gnu/services/monitoring.scm (vnstat-service-type): New variable. * doc/guix.texi (Monitoring Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-11doc: Update dicod-configuration exampleNathaniel Nicandro
* doc/guix.texi (Dictionary Service): Update dicod-configuration example to fix outdated WordNet database configuration. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-11doc: Clarify substitute* docstring with an example.Gabriel Wicki
* doc/guix.texi (Build Utilities): Update the corresponding passage. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2023-05-11services: dhcp-client-configuration: Add 'shepherd-requirement' field.Sergey Trofimov
* gnu/services/networking.scm (<dhcp-client-configuration>) [shepherd-requirement]: New field. (dhcp-client-shepherd-service): Honor it. (dhcp-client-configuration-shepherd-requirement): Export accessor. * doc/guix.texi (Networking Setup): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-11gnu: home: services: fontutils: Add support for SXML fragments.Andrew Patterson
* gnu/home/services/fontutils.scm (add-fontconfig-config-file): Add support for adding arbitrary SXML configuration into fonts.conf; * doc/guix.texi (Fonts Services): Update the documentation. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-10services: guix-build-coordinator-agent: Support max-parallel-uploads.Christopher Baines
This should be usable with the new guile-gnutls. * gnu/services/guix.scm (guix-build-coordinator-agent-configuration-max-parallel-uploads): New procedure. * gnu/services/guix.scm (guix-build-coordinator-agent-shepherd-services): Use the new argument. * doc/guix.texi (Guix Services): Document it.
2023-05-10doc: Fix module name for 'home-znc-service-type'.Blake Shaw
* doc/guix.texi (Messaging Home Services): Fix. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-09services: guix-build-coordinator: Support extra environment vars.Christopher Baines
I'm looking at this because I need to do some debugging of Guile's GC, and there are some useful environment variables for that, but it should be generally useful. * gnu/services/guix.scm (guix-build-coordinator-configuration-extra-environment-variables): New procedure. (guix-build-coordinator-shepherd-services): Pass the environment variables to the shepherd. * doc/guix.texi (Guix Services): Document it.
2023-05-08Partly reinstate "doc: Update all menus."Maxim Cournoyer
This partly reinstates commit 9719d7d ("doc: Update all menus."), omitting the hunk touching doc/contributing.texi. * doc/guix.texi: Update all menus.
2023-05-07Revert "doc: Update all menus."Maxim Cournoyer
This reverts commit 9719d7d2b0733c57e30bff3180ff0fa25c34c66f. It breaks Guix pull, building the 'guix-manual' for reasons that currently escape me.
2023-05-07doc: Update all menus.Maxim Cournoyer
Automated via 'M-x texinfo-all-menus-update' in Emacs, and dropping the *Contributing menu removal, which is erroneously removed because defined in a different Texinfo file. * doc/guix.texi: Update all menus. * doc/contributing.texi (Submitting Patches): Likewise.
2023-05-07doc: Add some information/recommendation regarding --sysconfdir.Maxim Cournoyer
* doc/contributing.texi (Building from Git): Mention sysconfdir along localstatedir. * doc/guix.texi (Requirements): Likewise.
2023-05-06doc: Use G-Expressions for package definition example.Bruno Victal
* doc/guix.texi (Build Phases): Use G-Expressions for example. Co-authored-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-05-06doc: cookbook: Remove outdated section about GUIX_PACKAGE_PATH.Ludovic Courtès
The section insisted on GUIX_PACKAGE_PATH, mentioned version 0.16, and didn't say much about channels, which made it look obsolete. * doc/guix-cookbook.texi (GUIX_PACKAGE_PATH): Remove section. (Guix channels): Rename to... (Channels): ... this. Merge most of the explanations previously in the GUIX_PACKAGE_PATH section. Say more about channels and add cross-references.
2023-05-04transformations: Add '--with-configure-flag'.Sarthak Shah
* guix/transformations.scm (transform-package-configure-flag): New procedure. (%transformation-options, %transformation-options) (show-transformation-options-help/detailed): Add it. * tests/transformations.scm ("options->transformation, with-configure-flag"): New test. * doc/guix.texi (Package Transformation Options): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2023-05-01doc: Simplify contributing section by automating git configuration.Maxim Cournoyer
Fixes <https://issues.guix.gnu.org/58813>. No longer suggests to splice the output of etc/teams.scm commands into the 'git send-email' command line; this is now transparently handled by the Git configuration, which is also automatic. * doc/contributing.texi (Configuring Git): Streamline section, now automated via Automake. (Sending a Patch Series): Do not specify options configured as default by the above. Prefer long option names, for readability. (Teams): Rewrite the examples to use --header-cmd. (Commit Access): Refer to the Configuring Git section instead of detailing manual steps.
generated by cgit v1.2.3 (git 2.46.2) at 2024-11-17 18:23:37 +0000