summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
2020-11-12maint: update-guix-package: Optionally add sources to store....Following discussions in <https://issues.guix.gnu.org/43893>, keeping a copy of the updated package source is desirable when generating a release. * build-aux/update-guix-package.scm (version-controlled?): Remove variable. (call-with-temporary-git-worktree): Renamed from 'with-temporary-git-worktree'. Update doc. Do not change directory implicitly. Define as a procedure, not a syntax. (keep-source-in-store): New procedure. (main): Adjust to use with call-with-temporary-git-worktree. Add the sources to the store when GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT is set. Exit gracefully when FIND-ORIGIN-REMOTE returns #f. (%savannah-guix-git-repo-push-url-regexp): Adjust match for a potential colon separator. * Makefile.am (GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT): Adjust. * .dir-locals.el (scheme-mode): Remove entry for with-temporary-git-worktree. * doc/contributing.texi (Updating the Guix Package): Update doc. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Maxim Cournoyer
2020-11-03doc: Illustrate procedures that return packages....* doc/guix.texi (Defining Package Variants): Illustrate procedures that return packages. Ludovic Courtès
2020-11-03doc: Use '@lisp' for 'options->transformation' example....* doc/guix.texi (Defining Package Variants): Use @lisp for 'options->transformation' example. Ludovic Courtès
2020-11-02doc: Fix typo....* doc/guix.texi (Invoking guix publish)<cache-bypass-threshold>: The unit suffixes the numeric value. Miguel Ángel Arruga Vivas
2020-11-02doc: Complete sentence in earlyoom-configuration doc....* doc/guix.texi (Linux Services): Complete sentence in earlyoom-configuration doc. Reported-by: Julien Lepiller <julien@lepiller.eu> Maxim Cournoyer
2020-11-01doc: Fix typo....* doc/guix.texi (DNS Services): Fix typo. Julien Lepiller
2020-11-01doc: Fix typo....* doc/guix.texi (Sound Services): Fix typo. Julien Lepiller
2020-11-01doc: Add missing period at the end of the sentence.Miguel Ángel Arruga Vivas
2020-10-31doc: Add "Defining Package Variants" section....* doc/guix.texi (Defining Packages): Move documentation of 'package-input-rewriting' & co. to... (Defining Package Variants): ... here. New node. Also document 'inherit' and 'options->transformation'. Ludovic Courtès
2020-10-30services: guix-publish: Add 'cache-bypass-threshold' field....This is a followup to ecaa102a58ad3ab0b42e04a3d10d7c761c05ec98. * gnu/services/base.scm (<guix-publish-configuration>)[cache-bypass-threshold]: New field. (guix-publish-shepherd-service): Honor it. Ludovic Courtès
2020-10-30services: swap: Allow for UUIDs and file system labels....* gnu/services/base.scm (swap-service-type)[device-lookup, device-name]: New variables. Add 'modules' field to 'shepherd-service'. In 'start' and 'stop', use 'device-lookup' to resolve UUIDs and labels. * doc/guix.texi (operating-system Reference): Adjust accordingly. Ludovic Courtès
2020-10-30scripts: lint: Add '--exclude' option....* guix/scripts/lint.scm (%options, parse-options): Add '--exclude' option. (option-checker): New helper function. * doc/guix.texi (Invoking guix lint): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> zimoun
2020-10-30scripts: lint: Fix '--no-network' option....* guix/scripts/lint.scm: (show-help): Add '--no-network' option message. (%options, parse-options): Fix argument order. * doc/guix.texi (Invoking guix lint): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> zimoun
2020-10-28doc: Fix claimed archive timestamps....Reported by Leo Famulari <leo@famulari.name>. * doc/guix.texi (Binary Installation): Use a correct timestamp of 1 instead of an incorrect one of 0. Tobias Geerinckx-Rice
2020-10-28publish: Add '--cache-bypass-threshold'....* guix/scripts/publish.scm (show-help, %options): Add '--cache-bypass-threshold'. (low-compression): New procedure. (cache-bypass-threshold): New parameter. (bypass-cache?): New procedure. (render-narinfo/cached): Call 'render-narinfo' when 'bypass-cache?' returns true. (render-nar/cached): Call 'render-nar' when 'bypass-cache?' returns true. (guix-publish): Parameterize 'cache-bypass-threshold'. * tests/publish.scm ("with cache", "with cache, lzip + gzip") ("with cache, uncompressed"): Pass '--cache-bypass-threshold=0'. ("with cache, vanishing item"): Expect 200 for RESPONSE. ("with cache, cache bypass"): New test. Ludovic Courtès
2020-10-28doc: Update the PostgreSQL extension packages example....* doc/guix.texi (PostgreSQL): Update the extension packages example. Christopher Baines
2020-10-28doc: Use @code rather than @var for data type items....In the couple of cases where it's inconsistent. * doc/guix.texi (PostgreSQL, Sound Services): Replace @var with @code within data type sections. Christopher Baines
2020-10-27doc: Fix various minor typos....* doc/guix.texi (Top): Add end of line period to menu entry in the node listing. (Invoking guix time-machine): Remove duplicate word. (Invoking guix environment): As above. (PAM Mount Service): As above. (Running Guix in a Virtual Machine): Remove erroneous hyphen and duplicate word. Signed-off-by: Leo Famulari <leo@famulari.name> Lulu
2020-10-27services: Add gmnisrv web service....* gnu/services/web.scm (<gmnisrv-configuration>): New record type. (%default-gmnisrv-config-file): New variable. (%gmnisrv-accounts, %gmnisrv-activation): New variables. (gmnisrv-shepherd-service): New procedure. (gmnisrv-service-type): New variable. * doc/guix.texi (Web Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Alexandru-Sergiu Marton
2020-10-27doc: Fix xref translation macro....* doc/local.mk (xref_command): Wrap loop body in 'if [ -n "$$e" ]'. This avoids shell syntax errors when producing doc/guix-cookbook.de.texi, which for some reason gets an empty 'e' at one point. Quote the first argument to 'head'. Ludovic Courtès
2020-10-25doc: Document the postgresql-config-file....* doc/guix.texi (PostgreSQL): Document the postgresql-config-file record. Christopher Baines
2020-10-25doc: Add "Getting Substitutes from Other Servers" section....* doc/guix.texi (Getting Substitutes from Other Servers): New node. (Invoking guix-daemon): Add cross-reference. (Substitute Server Authorization): Clarify that this is unnecessary on Guix System. (Invoking guix publish): Add cross-reference. Ludovic Courtès
2020-10-25services: guix: Make /etc/guix/acl really declarative by default....Fixes <https://bugs.gnu.org/39819>. Reported by Maxim Cournoyer <maxim.cournoyer@gmail.com>. * gnu/services/base.scm (substitute-key-authorization): Symlink DEFAULT-ACL to /etc/guix/acl unconditionally. Add code to optionally back up /etc/guix/acl if it was possibly modified by hand. * doc/guix.texi (Base Services): Clarify the effect of setting 'authorize-keys?' to true. Mention the backup. Give an example showing how to authorize substitutes from another server. Ludovic Courtès
2020-10-24build: Add GUIX_GIT_KEYRING variable for make authenticate....* Makefile.am (GUIX_GIT_KEYRING): New variable. (authenticate): Use GUIX_GIT_KEYRING to select the keyring branch reference. * doc/contributing.texi (Building from Git): Add an example about the use of GUIX_GIT_KEYRING. Miguel Ángel Arruga Vivas
2020-10-22git: Require Guile-Git 0.3.0 or later....* guix/git.scm (auth-supported?): Remove. (clone*): Inline code that was dependent on AUTH-SUPPORTED?. (update-cached-checkout): Likewise. (resolve-reference): Remove check for 'object-lookup-prefix' and use it unconditionally. (load-git-submodules): Remove. (update-submodules): Use 'repository-submodules', 'submodule-lookup', etc. unconditionally. (update-cached-checkout): Use 'repository-close!' unconditionally. * m4/guix.m4 (GUIX_CHECK_GUILE_GIT): New macro. * configure.ac: Use it and error out when it fails. * doc/guix.texi (Requirements): Bump to Guile-Git 0.3.0. Ludovic Courtès
2020-10-21doc: Move documentation of singularity-service-type....Fixes <https://bugs.gnu.org/44126>. * doc/guix.texi: Move documentation of singularity-service-type from "Auditd Service" heading to "Docker Service" heading. Ricardo Wurmus
2020-10-21doc: Capitalize "Hurd" in 'operating-system' reference....* doc/guix.texi (operating-system Reference): Capitalize "Hurd". Ludovic Courtès
2020-10-21doc: Add an entry for the 'keyboard-layout' procedure....* doc/guix.texi (Keyboard Layout): Add @deffn entry for 'keyboard-layout'. Ludovic Courtès
2020-10-21doc: Fix typo in 'avahi-service-type' description....* doc/guix.texi (Networking Services): Change "zero-configuration" to "avahi-configuration". Ludovic Courtès
2020-10-21doc: Fix typo in 'git-fetch' description....* doc/guix.texi (origin Reference): Replace "git-download" with "git-fetch" in one sentence. Ludovic Courtès
2020-10-21doc: Cookbook links to /manual/devel, not /manual....Since the Cookbook is built from the 'master' branch, it should point to the manual from that same branch. * doc/build.scm (guix-mono-node-indexes, guix-split-node-indexes): Link to /manual/devel when %MANUAL is not "guix". Ludovic Courtès
2020-10-20services: databases: Don't specify a default postgresql version....Currently, if the postgresql package major version changes, this is going to break the service upon upgrade, because PostgreSQL will reject the data files from the differing major version of the service. Because it's important to either keep running a particular major version, or intentionally upgrade, I think the configuration would be better with no default. I think this is also going to be helpful when trying to assist users upgrading PostgreSQL. * gnu/services/databases.scm (<postgresql-configuration>): Remove default for postgresql. (postgresql-service-type): Remove the default value. * gnu/tests/databases.scm (%postgresql-os): Update accordingly. * gnu/tests/guix.scm (%guix-data-service-os): Update accordingly. * gnu/tests/monitoring.scm (%zabbix-os): Update accordingly. * gnu/tests/web.scm (patchwork-os): Update accordingly. * doc/guix.texi (PostgreSQL): Update accordingly. Christopher Baines
2020-10-20services: databases: Deprecate the postgresql-service procedure....Using the service type directly is a better approach, making it easier to configure the service. * gnu/services/databases.scm (postgresql-service): Deprecate this procedure. * doc/guix.texi (PostgreSQL): Update the documentation for the use of (service postgresql-service-type). Christopher Baines
2020-10-20doc: Add subheadings in to the Databases section....To make it clearer where the relevant documentation for a particular service starts and ends. * doc/guix.texi (Database Services): Add subheadings. Christopher Baines
2020-10-20guix build: Move package transformation options behind '--help-transform'....This change declutters the '--help' output. * guix/scripts/build.scm (show-build-options-help) (%standard-build-options): Add '--help-transform'. (show-transformation-options-help): Make private. (show-help): Remove call to 'show-transformation-options-help'. * guix/scripts/build.scm (show-help): Likewise. * guix/scripts/environment.scm (show-help): Likewise. * guix/scripts/graph.scm (show-help): Likewise. * guix/scripts/install.scm (show-help): Likewise. * guix/scripts/pack.scm (show-help): Likewise. * guix/scripts/package.scm (show-help): Likewise. * guix/scripts/upgrade.scm (show-help): Likewise. * doc/guix.texi (Package Transformation Options): Mention '--help-transform'. Ludovic Courtès
2020-10-20guix build: Add '--with-debug-info'....* guix/scripts/build.scm (transform-package-with-debug-info): New procedure. (%transformations): Add 'with-debug-info'. (%transformation-options, show-transformation-options-help): Add '--with-debug-info'. * tests/scripts-build.scm ("options->transformation, with-debug-info"): New test. * doc/guix.texi (Package Transformation Options): Document '--with-debug-info'. (Installing Debugging Files): Introduce sections. Remove bit about eventual "opt-out" since this is not happening. Document '--with-debug-info' under "Rebuilding with Debugging Info". Ludovic Courtès
2020-10-20doc: Replace @example with @lisp in "Build Phases"....* doc/guix.texi (Build Phases): Use @lisp for second example. Ludovic Courtès
2020-10-20doc: More uses of @lisp instead of @example....* doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example. Ludovic Courtès
2020-10-20doc: Fix misuses of @var in "Defining Packages"....* doc/guix.texi (Defining Packages): Use @code instead of @var where appropriate. Ludovic Courtès
2020-10-20doc: Add "Build Phases" section....* doc/guix.texi (Build Phases): New section. (Build Systems): Remove 'modify-phases' example and add cross-reference to "Build Phases". (Build Utilities)[Build Phases]: Simplify intro and link to "Build Phases". (G-Expressions): Add index entries for "code staging" and add cross-reference to "Build Phases". Ludovic Courtès
2020-10-20doc: Document 'url-fetch', 'git-fetch', and 'git-reference'....* doc/guix.texi (origin Reference): Rewrite initial paragraph. Properly document 'method' and its protocol. Document 'url-fetch', 'git-fetch', and 'git-reference' separately. Ludovic Courtès
2020-10-20services: Add LXQt desktop service....* gnu/services/desktop.scm (lxqt-desktop-service-type): New variable. (<lxqt-desktop-configuration>): New record type. (lxqt-desktop-configuration?): New procedure. * doc/guix.texi (Desktop Services): Document this. Co-authored-by: Oleg Pykhalov <go.wigust@gmail.com> Reza Alizadeh Majd
2020-10-19maint: update-guix-package: Prevent accidentally breaking guix pull....Fixes <https://issues.guix.gnu.org/43893>. This changes the 'update-guix-package' tool so that it: 1. Always uses a clean checkout to compute the hash of the updated 'guix' package. 2. Ensures the commit used in the updated 'guix' package definition has already been pushed upstream. * build-aux/update-guix-package.scm (%savannah-guix-git-repo-push-url): New variable. (with-input-pipe-to-string, with-temporary-git-worktree): New syntaxes. (find-origin-remote, git-add-worktree): New procedures. (commit-already-pushed?): New predicate. (main): Check the commit used has already been pushed upstream and compute the hash from a clean checkout. * doc/contributing.texi (Updating the Guix Package): Document it. * .dir-locals.el (scheme-mode): Fix indentation of with-temporary-git-worktree. Maxim Cournoyer
2020-10-19doc: Produce stylable HTML for @deftp, @deffn, etc....'makeinfo --help' uses <strong> and <em> for those entries. Replace that with CSS classes. * doc/build.scm (html-manual-identifier-index)[build]: Adjust to handle rewritten forms of <dt> entries. * doc/build.scm (syntax-highlighted-html)[build][syntax-highlight]: Handle <dt> forms and replace them. [highlight-definition, space?]: New procedures. Ludovic Courtès
2020-10-17doc: Fix typo....* doc/guix.texi (Invoking guix import): Fix typo. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Aniket Patil
2020-10-17doc: cookbook: Balance parens in custom kernel examples....* doc/guix-cookbook.texi (Customizing the Kernel): Add missing paren in example. Remove extra parens in other example. Ludovic Courtès
2020-10-17doc: Generate cross-references in code snippets to the Guile manual....Occurrences of 'list', 'cons', etc. in code snippets now link to the relevant section of the Guile manual. * doc/build.scm (guile-manual, %guile-manual-base-url) (guile-mono-node-indexes, guile-split-node-indexes): New variables. (for-all-languages, merge-index-alists): New procedures. <top level>: Rename 'mono-node-indexes' and 'split-node-indexes' to 'guix-mono-node-indexes' and 'guix-split-node-indexes' respectively. Add 'mono-node-indexes' and 'split-node-indexes' defined as calls to 'merge-index-alists'. Ludovic Courtès
2020-10-17doc: Allow code snippets in the cookbook to link to the manual....Until now, only code snippets in the manual itself would contain links to identifier definitions. Now snippets in the cookbook also link to definitions in the manual. * doc/build.scm (html-manual): Add #:mono-node-indexes and #:multi-node-indexes and pass it to 'syntax-highlighted-html'. (pdf+html-manual): Likewise, and pass it to 'html-manual'. <top level>: Factorize 'version' and 'source'. Define 'guix-manual', 'mono-node-indexes', and 'split-node-indexes'. Pass #:mono-node-indexes and #:split-node-indexes to 'pdf+html-manual'. Ludovic Courtès
2020-10-17doc: Move manual index creation to a separate derivation....* doc/build.scm (normalize-language-code, html-manual-identifier-index): New procedures. (syntax-highlighted-html): Add #:mono-node-indexes and #:split-node-indexes. [build](underscore-decode, anchor-id->key, collect-anchors): Remove. (language+node-anchors, mono-node-anchors, multi-node-anchors): New variables. Use them. Ludovic Courtès
2020-10-17doc: Remove 'build.scm' from the source of the manual....That way we no longer have to rebuild the whole manual when fiddling with 'build.scm'. * doc/build.scm <top level>: Define 'select?' and pass it to 'pdf+html-manual'. Ludovic Courtès