aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* doc: Fix various minor typos.Lulu2020-10-27
| | | | | | | | | | * 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>
* services: Add gmnisrv web service.Alexandru-Sergiu Marton2020-10-27
| | | | | | | | | | | * 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>
* doc: Fix xref translation macro.Ludovic Courtès2020-10-27
| | | | | | | * 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'.
* doc: Document the postgresql-config-file.Christopher Baines2020-10-25
| | | | * doc/guix.texi (PostgreSQL): Document the postgresql-config-file record.
* doc: Add "Getting Substitutes from Other Servers" section.Ludovic Courtès2020-10-25
| | | | | | | | * 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.
* services: guix: Make /etc/guix/acl really declarative by default.Ludovic Courtès2020-10-25
| | | | | | | | | | | | 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.
* build: Add GUIX_GIT_KEYRING variable for make authenticate.Miguel Ángel Arruga Vivas2020-10-24
| | | | | | | | * 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.
* git: Require Guile-Git 0.3.0 or later.Ludovic Courtès2020-10-22
| | | | | | | | | | | | | | | * 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.
* doc: Move documentation of singularity-service-type.Ricardo Wurmus2020-10-21
| | | | | | | Fixes <https://bugs.gnu.org/44126>. * doc/guix.texi: Move documentation of singularity-service-type from "Auditd Service" heading to "Docker Service" heading.
* doc: Capitalize "Hurd" in 'operating-system' reference.Ludovic Courtès2020-10-21
| | | | * doc/guix.texi (operating-system Reference): Capitalize "Hurd".
* doc: Add an entry for the 'keyboard-layout' procedure.Ludovic Courtès2020-10-21
| | | | | * doc/guix.texi (Keyboard Layout): Add @deffn entry for 'keyboard-layout'.
* doc: Fix typo in 'avahi-service-type' description.Ludovic Courtès2020-10-21
| | | | | * doc/guix.texi (Networking Services): Change "zero-configuration" to "avahi-configuration".
* doc: Fix typo in 'git-fetch' description.Ludovic Courtès2020-10-21
| | | | | * doc/guix.texi (origin Reference): Replace "git-download" with "git-fetch" in one sentence.
* doc: Cookbook links to /manual/devel, not /manual.Ludovic Courtès2020-10-21
| | | | | | | | 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".
* services: databases: Don't specify a default postgresql version.Christopher Baines2020-10-20
| | | | | | | | | | | | | | | | | | | | 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.
* services: databases: Deprecate the postgresql-service procedure.Christopher Baines2020-10-20
| | | | | | | | | 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).
* doc: Add subheadings in to the Databases section.Christopher Baines2020-10-20
| | | | | | | To make it clearer where the relevant documentation for a particular service starts and ends. * doc/guix.texi (Database Services): Add subheadings.
* guix build: Move package transformation options behind '--help-transform'.Ludovic Courtès2020-10-20
| | | | | | | | | | | | | | | | | 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'.
* guix build: Add '--with-debug-info'.Ludovic Courtès2020-10-20
| | | | | | | | | | | | | | | * 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".
* doc: Replace @example with @lisp in "Build Phases".Ludovic Courtès2020-10-20
| | | | * doc/guix.texi (Build Phases): Use @lisp for second example.
* doc: More uses of @lisp instead of @example.Ludovic Courtès2020-10-20
| | | | | | * doc/guix.texi (G-Expressions): Use @lisp for 'let-system' example. * doc/contributing.texi (Synopses and Descriptions): Use @lisp for second example.
* doc: Fix misuses of @var in "Defining Packages".Ludovic Courtès2020-10-20
| | | | | * doc/guix.texi (Defining Packages): Use @code instead of @var where appropriate.
* doc: Add "Build Phases" section.Ludovic Courtès2020-10-20
| | | | | | | | | | * 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".
* doc: Document 'url-fetch', 'git-fetch', and 'git-reference'.Ludovic Courtès2020-10-20
| | | | | | * doc/guix.texi (origin Reference): Rewrite initial paragraph. Properly document 'method' and its protocol. Document 'url-fetch', 'git-fetch', and 'git-reference' separately.
* services: Add LXQt desktop service.Reza Alizadeh Majd2020-10-20
| | | | | | | | | * 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>
* maint: update-guix-package: Prevent accidentally breaking guix pull.Maxim Cournoyer2020-10-19
| | | | | | | | | | | | | | | | | | | | | 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.
* doc: Produce stylable HTML for @deftp, @deffn, etc.Ludovic Courtès2020-10-19
| | | | | | | | | | | '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.
* doc: Fix typo.Aniket Patil2020-10-17
| | | | | | * doc/guix.texi (Invoking guix import): Fix typo. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: cookbook: Balance parens in custom kernel examples.Ludovic Courtès2020-10-17
| | | | | * doc/guix-cookbook.texi (Customizing the Kernel): Add missing paren in example. Remove extra parens in other example.
* doc: Generate cross-references in code snippets to the Guile manual.Ludovic Courtès2020-10-17
| | | | | | | | | | | | | 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'.
* doc: Allow code snippets in the cookbook to link to the manual.Ludovic Courtès2020-10-17
| | | | | | | | | | | | | 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'.
* doc: Move manual index creation to a separate derivation.Ludovic Courtès2020-10-17
| | | | | | | | | | * 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.
* doc: Remove 'build.scm' from the source of the manual.Ludovic Courtès2020-10-17
| | | | | | | | 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'.
* doc: Fixes for Texinfo metainfo.Miguel Ángel Arruga Vivas2020-10-17
| | | | | | | | * doc/guix.texi (guix-pack)[GUIX_EXECUTION_ENGINE]: Use @env instead of @code. (zram-device-service-type): Use @code instead of @var for constant or symbolic values. (rshiny-service-type): Use @env instead of @code for R_LIBS_USER.
* doc: Fix minor typos.Miguel Ángel Arruga Vivas2020-10-17
| | | | | | | | | | | | | | * doc/guix.texi (cargo-build-system): Fix install phase description. (julia-build-system): Fix typo and add information from check. (pulseaudio-configuration): Remove duplicated words. (knot-acl-configuration)[id]: Fix typo. (mpd-output)[extra-options]: Likewise. (libvirt-configuration) [listen-tls?]: Add missing subject. [listen-tcp?]: Add missing subject and period. [tls-port, tcp-port, log-filters]: Add missing period. (hurd-vm-configuration)[netoptions]: Fix typo in example. (ganeti-watcher-service-type): Fix typo. (grub-theme)[gfxmode]: Remove see before @pxref.
* doc: cookbook: Clarify what keywords are.Ludovic Courtès2020-10-15
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Clarify what keywords are.
* doc: Improve "Build Utilities".Ludovic Courtès2020-10-15
| | | | | * doc/guix.texi (Build Utilities): Fix typos. Provide the correct syntax for 'substitute*'. Add a 'modify-phases' example.
* doc: Add "Build Utilities" section.Ludovic Courtès2020-10-15
| | | | | | | * doc/guix.texi (Build Utilities): New section. (Defining Packages): Refer to it. (Build Systems): Likewise. * doc/guix-cookbook.texi (Extended example): Likewise.
* doc: cookbook: Use @code for the identifiers of utility functions.Ludovic Courtès2020-10-15
| | | | * doc/guix-cookbook.texi (Utility functions): Use @code instead of @asis.
* doc: cookbook: More "#true" and "#false".Ludovic Courtès2020-10-15
| | | | | * doc/guix-cookbook.texi (Extended example) (Customizing the Kernel, Running Guix on a Linode Server): Use #true and #false.
* doc: cookbook: Use @var for meta-syntactic variables.Ludovic Courtès2020-10-15
| | | | | * doc/guix-cookbook.texi (Extended example): Use @var for meta-syntactic variables in 'modify-phases' description.
* doc: cookbook: Fix 'let' form in example.Ludovic Courtès2020-10-15
| | | | * doc/guix-cookbook.texi (Extended example): Fix 'let' form in example.
* doc: Fix typo.Mathieu Othacehe2020-10-15
| | | | * doc/guix.texi (Guix Build Coordinator): Fix typo.
* services: nginx: Add lua module.Oleg Pykhalov2020-10-14
| | | | | | | | * gnu/services/web.scm (<nginx-configuration>) [lua-package-path, lua-package-cpath]: New record types. * gnu/services/web.scm (default-nginx-config): Use them. * doc/guix.texi (Web Services): Document this. * doc/guix-cookbook.texi (System Configuration): Document this.
* doc: cookbook: Mention "#true" and "#false".Ludovic Courtès2020-10-14
| | | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Mention "#true" and "#false". (Extended example): Likewise.
* doc: Mention "i586-gnu" as supported and experimental.Ludovic Courtès2020-10-14
| | | | * doc/guix.texi (GNU Distribution): Mention "i586-gnu".
* doc: Avoid orphan node.Ludovic Courtès2020-10-14
| | | | | | | | | | Commit 4b5a6fbc9b754c0ca70d033dd99f17c4f028733a turned "Transparent Emulation with QEMU" into a node, but that was an orphan node, with no up/next/previous links. * doc/guix.texi (Virtualization Services): Capitalize subsection title. (Transparent Emulation with QEMU): Remove "@node" and add "@anchor". (Daemon Offload Setup): Adjust cross-reference accordingly.
* guix build: Add '--with-c-toolchain'.Ludovic Courtès2020-10-12
| | | | | | | | | | | | | | * guix/scripts/build.scm (package-dependents/spec) (package-toolchain-rewriting, transform-package-toolchain): New procedures. (%transformations): Add it. (%transformation-options, show-transformation-options-help): Add '--with-c-toolchain'. * tests/scripts-build.scm (depends-on-toolchain?): New procedure. ("options->transformation, with-c-toolchain") ("options->transformation, with-c-toolchain twice") New test. ("options->transformation, with-c-toolchain, no effect"): New tests. * doc/guix.texi (Package Transformation Options): Document it.
* packages: Add 'package-with-c-toolchain'.Ludovic Courtès2020-10-12
| | | | | | | | * guix/build-system.scm (build-system-with-c-toolchain): New procedure. * guix/packages.scm (package-with-c-toolchain): New procedure. * tests/packages.scm ("package-with-c-toolchain"): New test. * doc/guix.texi (package Reference): Document 'package-with-c-toolchain'. (Build Systems): Mention it.
* doc: Sync the client and daemon --rounds options documentation.Maxim Cournoyer2020-10-09
| | | | | | | | | Fixes <https://issues.guix.gnu.org/40867>. * doc/guix.texi (Common Build Options): Suggest using '--keep-failed' to keep differing build results in the store rather than 'guix archive'. Reported-by: Jonathan Brielmaier <jonathan.brielmaier@web.de>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-24 08:09:52 +0000