aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-11-17doc: Improve wording for param spec of `./configure`.Rostislav Svoboda
* doc/contributing.texi (Running Guix Before It Is Installed): Writing "Do <this>. But it won't work unless ..." is a bad practice. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17scripts: home: Make ‘guix home import’ write home-configuration.scm.Xinglu Chen
* guix/scripts/home.scm (process-command): Populate ‘home-configuration.scm’ in the destination directory instead of printing to stdout. * doc/guix.texi (Declaring the Home Environment): Adjust accordingly. (Invoking guix home): Likewise. Suggested-by: Ludovic Courtès <ludo@gnu.org> Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17services: docker: Add 'environment-variables' configuration field.Alexey Abramov
* gnu/services/docker.scm (docker-configuration): Add the field (docker-shepherd-service): Pass the list of defined variables to make-forkexec-constructor. * doc/guix.texi (Miscellaneous Services): Update doc. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-17import: Replace texlive importer.Ricardo Wurmus
* guix/import/texlive.scm (fetch-sxml, sxml->package): Remove procedures. (tlpdb-file, tlpdb, files->directories, tlpdb->package): New procedures. (string->license): Add case for lpplgpl license combination. (guix-name): Remove COMPONENT argument. (texlive->guix-package): Use new procedures. (texlive-recursive-import): New procedure. * guix/scripts/import/texlive.scm (show-help, %options): Remove --archive option. (guix-import-texlive): Adjust call of texlive->guix-package. * doc/guix.texi (Invoking guix import): Update documentation.
2021-11-16services: cups: Update default timeouts.Tobias Geerinckx-Rice
Upstream raised these back in 2019 with CUPS 2.3.0. * gnu/services/cups.scm (<cups-configuration>): Raise default ‘multiple-operation-timeout’ and ‘timeout’ from 300 to 900 seconds. * doc/guix.texi (Printing Services): Adjust accordingly.
2021-11-16doc: Remove obsolete example module import.Tobias Geerinckx-Rice
This follows up on commit a247f5c7537df7e0c09051ba22d5c95eb08f48b9. * doc/guix.texi (X Window): Remove unused (srfi srfi-1) from the modify-services example.
2021-11-15gnu: hpcguix-web: Update to 0.2.0.Ludovic Courtès
* gnu/packages/web.scm (hpcguix-web): Update to 0.2.0. [arguments]: In 'wrap-program' phase, add guile-zlib to DEPS. [native-inputs]: Add GUILE. [inputs]: Add GUILE-ZLIB, GUILE-COMMONMARK, and GUILE-JSON. [propagated-inputs]: Remove. These were pointless. * gnu/services/web.scm (<hpcguix-web-configuration>)[address, port]: New fields. * doc/guix.texi (Web Services): Document them. * gnu/tests/web.scm (%hpcguix-web-os): Add 'address'.
2021-11-14doc: Add a note about elogind and XDG_RUNTIME_DIR for Guix Home.Andrew Tropin
* doc/guix.texi (Declaring the Home Environment): Add a note about elogind and XDG_RUNTIME_DIR. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-11-14doc: Add example to dist target.Julien Lepiller
* doc/local.mk (OS_CONFIG_EXAMPLES_TEXI): Add he-config-bare-bones.scm.
2021-11-14doc: Fix guix shell -C example.Florian Pelz
The meaning changed by accident when guix environment was replaced by guix shell in 80edb7df6586464aa40e84e103f0045452de95db. * doc/guix.texi (Debugging Build Failures): Add missing -D option.
2021-11-12services: Add qemu-guest-agent service.Timotej Lazar
* gnu/services/virtualization.scm (<qemu-guest-agent-configuration>): New record. (qemu-guest-agent-shepherd-service): New procedure. (qemu-guest-agent-service-type): New variable. * doc/guix.texi (Virtualization Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-11import: cran: Allow imports of a specific version.Ludovic Courtès
* guix/import/cran.scm (download): Handle the case where URL is a list. (fetch-description-from-tarball): New procedure. (fetch-description): Add #:version parameter. Honor it when REPOSITORY is 'cran. Use 'fetch-description-from-tarball' when REPOSITORY is 'bioconductor. (description->package): SOURCE-URL may now be a list. (cran->guix-package): Pass VERSION to 'fetch-description'. (cran-recursive-import): Add #:version parameter. * guix/scripts/import/cran.scm (guix-import-cran): Expect a spec rather than a mere package name. * doc/guix.texi (Invoking guix import): Document it.
2021-11-11import: pypi: Allow imports of a specific version.Ludovic Courtès
* guix/import/pypi.scm (latest-version): New procedure. (latest-source-release): Rename to... (source-release): ... this. Add 'version' parameter. (latest-wheel-release): Rename to... (wheel-release): ... this. Add 'version' parameter. (pypi->guix-package): Honor 'version' parameter. (pypi-recursive-import): Add 'version' parameter and honor it. * guix/scripts/import/pypi.scm (guix-import-pypi): Expect a spec. Pass it to 'package-name->name+version'. Pass the 'version' parameter. * tests/pypi.scm ("pypi->guix-package, no wheel"): Exercise the #:version parameter. * doc/guix.texi (Invoking guix import): Document it.
2021-11-09doc: Fix typo.Nicolas Goaziou
* doc/guix.texi (Invoking guix shell): Fix a typo.
2021-11-07import: egg: Allow imports of a specific version.Xinglu Chen
* guix/import/egg.scm (eggs-repository): Change URL. (egg-metadata): Accept optional #:version keyword argument. (egg->guix-package): Accept ‘version’ argument. (egg-recursive-import): Add ‘version’ argument and honor it. * guix/scripts/import/egg.scm (guix-import-egg): Parse a specification instead of just a package name. * doc/guix.texi (Invoking guix import): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-07doc: Improve documentation of the Bash home serviceXinglu Chen
* doc/guix.texi (Shells Home Services): Document ‘home-bash-extension’ configuration record. * gnu/home/services/shells.scm (generate-home-bash-documentation): Extract docstrings from ‘home-bash-extension’. (home-bash-configuration): Expound on docstrings. (home-bash-extension): Likewise. Fixes: <https://issues.guix.gnu.org/50991> Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-07home: services: bash: Add ‘aliases’ field.Xinglu Chen
* doc/guix.texi (Shells Home Services): Document it. * gnu/home/services/shells.scm (bash-serialize-aliases): New procedure. (home-bash-configuration, home-bash-extension): Add ‘aliases’ field. (home-bash-extensions): Adjust accordingly. * guix/scripts/home/import.scm (generate-bash-configuration+modules): Populate the ‘alias’ field. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-11-06profiles: Build the man database only if 'man-db' is in the profile.Ludovic Courtès
This allows us to skip the expensive man-db profile hook in most cases. Suggested by Liliana Marie Prikler <liliana.prikler@gmail.com>. * guix/profiles.scm (manual-database/optional): New procedure. (%default-profile-hooks): Use it instead of 'manual-database'. * doc/guix.texi (Documentation): Add footnote about 'man -k' database creation.
2021-11-06nls: Update translations.Julien Lepiller
* po/doc/guix-cookbook.es.po: New file. * po/doc/local.mk: Add 'es' cookbook. * doc/local.mk: Add 'es' cookbook.
2021-10-31doc: Mention 'guix home reconfigure' upfront.Ludovic Courtès
* doc/guix.texi (Declaring the Home Environment): Mention 'guix home reconfigure'.
2021-10-31doc: Avoid misuse of @ref.Ludovic Courtès
* doc/guix.texi (Declaring the Home Environment): Avoid @ref in the middle of a sentence.
2021-10-31doc: Mention "guix home import" upfront.Ludovic Courtès
* doc/guix.texi (Declaring the Home Environment): Mention "guix home import".
2021-10-31doc: Document the ‘guix home import’ subcommand.Xinglu Chen
* doc/guix.texi (Invoking guix home): Document ‘guix home import’. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-28doc: Allow offloading of the expensive derivations.Ludovic Courtès
* doc/build.scm (translated-texi-manuals) (html-manual, pdf-manual): Pass #:local-build? #f.
2021-10-26environment: Add '--check'.Ludovic Courtès
* guix/scripts/environment.scm (show-environment-options-help) (%options): Add '--check'. * guix/scripts/environment.scm (child-shell-environment) (validate-child-shell-environment): New procedures. (guix-environment*): Call 'validate-child-shell-environment' when 'check?' key is in OPTS. * doc/guix.texi (Invoking guix shell): Shorten footnote about Bash startup files. Document '--check' and mention startup files. (Invoking guix environment): Document '--check'.
2021-10-25shell: Maintain a profile cache.Ludovic Courtès
shell: Maintain a profile cache. With this change, running "guix shell" (no arguments) is equivalent to: guix environment -r ~/.cache/guix/profiles/some-root -l guix.scm This is the cache miss. On cache hit, it's equivalent to: guix environment -p ~/.cache/guix/profiles/some-root ... which can run in 0.1s. * guix/scripts/shell.scm (options-with-caching): New procedure. (parse-args): Use it. (%profile-cache-directory): New variable. (profile-cache-key, profile-cached-gc-root): New procedures. (show-help, %options): Add '--rebuild-cache'. (guix-shell)[cache-entries, entry-expiration]: New procedures. Add call to 'maybe-remove-expired-cache-entries'. * doc/guix.texi (Invoking guix shell): Document '--rebuild-cache'.
2021-10-25shell: By default load the local 'manifest.scm' or 'guix.scm' file.Ludovic Courtès
* guix/scripts/shell.scm (parse-args): Add call to 'auto-detect-manifest'. (authorized-directory-file, authorized-shell-directory?) (find-file-in-parent-directories, auto-detect-manifest): New procedures. * tests/guix-shell.sh: Add test. * doc/guix.texi (Invoking guix shell): Document it.
2021-10-25Add 'guix shell'.Ludovic Courtès
* guix/scripts/shell.scm, tests/guix-shell.sh: New files. * Makefile.am (MODULES): Add 'shell.scm'. (SH_TESTS): Add 'tests/guix-shell.sh'. * guix/scripts/environment.scm (show-environment-options-help): New procedure. (show-help): Use it. (guix-environment*): New procedure. (guix-environment): Use it. * po/guix/POTFILES.in: Add it. * doc/guix.texi (Features): Refer to "guix shell" (Invoking guix package): Likewise. (Development): Likewise. (Invoking guix shell): New node. (Invoking guix environment): Add deprecation warning. (Debugging Build Failures): Use 'guix shell' in examples. (Invoking guix container): Refer to 'guix shell'. (Invoking guix processes, Virtualization Services): Adjust examples to use 'guix shell'. * doc/contributing.texi (Building from Git): Refer to 'guix shell'. * etc/completion/bash/guix: Handle "shell".
2021-10-25profiles: Add 'package->development-manifest'.Ludovic Courtès
* guix/profiles.scm (package->development-manifest): New procedure. * guix/scripts/environment.scm (input->manifest-entry) (package-environment-inputs): Remove. * guix/scripts/environment.scm (options/resolve-packages): Use 'package->development-manifest' instead of 'package-environment-inputs'. * tests/profiles.scm ("package->development-manifest"): New test.
2021-10-25packages: Add 'package-development-inputs'.Ludovic Courtès
* guix/packages.scm (package-development-inputs): New procedure. * guix/scripts/environment.scm (package-environment-inputs): Use it. * tests/packages.scm ("package-development-inputs") ("package-development-inputs, cross-compilation"): New tests. * doc/guix.texi (package Reference): Document it.
2021-10-25services: rsync: support binding rsync to a specific IP addressJacob Adams
* gnu/services/rsync.scm (<rsync-configuration>)[address]: New field. (rsync-config-file): Honor it. * doc/guix.texi (Networking Services): Document new address rsync configuration option. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-22doc: Set LC_ALL when translating xref commands.Julien Lepiller
* doc/local.mk (xref_command): Set LC_ALL.
2021-10-20doc: Fix typo.Tobias Geerinckx-Rice
* doc/guix.texi (Invoking guix system, Invoking guix home): Fix ‘are […] two month old’ typo.
2021-10-17maint: Factorize po xref translation.Julien Lepiller
This ensures we use the same method in "make" as in "guix/self.scm". * Makefile.am: Build guix/build/po.scm. * build-aux/convert-xref.scm: New file. * doc/local.mk (xref_command): Use it. * guix/self.scm (translate-cross-references): Move it... * guix/build/po.scm: Parse comments and flags separately to find fuzzy flags. (translate-cross-references): ...here. (parse-tree->assoc): Ignore fuzzy entries.
2021-10-16home: services: shells: Fix documentation about file-like objects.Oleg Pykhalov
* gnu/home/services/shells.scm: (home-shell-profile-configuration, home-shell-profile-service-type, home-zsh-configuration, home-zsh-extension, home-bash-configuration, home-bash-extension, home-fish-configuration, home-fish-extension): Replace 'strings or gexps' with 'file-like objects' in the documentation. * doc/guix.texi (Shells Home Services): Same.
2021-10-14doc: Fix typo.Marius Bakke
* doc/contributing.texi (Configuring Git): s/respository/repository/
2021-10-11doc: Fix typo.Marius Bakke
* doc/guix.texi (Virtualization Services): Adjust Ganeti service name.
2021-10-11doc: guix: Fix typo.Oleg Pykhalov
Reported by Maxime Devos <maximedevos@telenet.be>. * doc/guix.texi (Invoking guix home): Fix typo.
2021-10-09Move (gnu home-services) to (gnu home services).Oleg Pykhalov
* gnu/home-services.scm (%guix-home-root-directory): Replace gnu/home-services.scm with "gnu/home/services.scm". Rename to gnu/home/services.scm. * gnu/local.mk (GNU_SYSTEM_MODULES): Rename gnu/home-services.scm to gnu/home/services.scm. * doc/he-config-bare-bones.scm: Replace (gnu home-services) with (gnu home services). * gnu/home.scm: Same. * gnu/home/services/fontutils.scm: Same. * gnu/home/services/mcron.scm: Same. * gnu/home/services/shells.scm: Same. * gnu/home/services/shepherd.scm: Same. * gnu/home/services/symlink-manager.scm: Same. * gnu/home/services/xdg.scm: Same. * guix/scripts/home.scm: Same. * guix/self.scm: Same.
2021-10-09doc: guix: Fix home services locations.Oleg Pykhalov
This commit follows ba8ddb348045f81f061a1c7f51c0f7c2b0024e71. * doc/guix.texi (Invoking guix home): Fix home services locations.
2021-10-08gnu: Move (gnu home-services) to (gnu home services).Oleg Pykhalov
* gnu/home-services/configuration.scm: Move the content ... * gnu/home/services/configuration.scm: ... here. * doc/guix.texi: Replace (gnu home-services mcron) with (gnu home services mcron). Replace (gnu home-services) with (gnu home services). * gnu/home.scm: Replace (gnu home-services fontutils) with (gnu services fontutils). Replace (gnu home-services shells) with (gnu home services shells). Replace (gnu home-services symlink-manager) with (gnu home services symlink-manager). Replace (gnu home-services xdg) with (gnu home services xdg). * gnu/home-services/fontutils.scm: Rename to gnu/services/fontutils.scm. * gnu/home-services/mcron.scm: Move to gnu/home/services/mcron.scm. Replace (gnu home-services shepherd) with (gnu home services shepherd). * gnu/home-services.scm (%service-type-path): Search home services in "gnu/services". * gnu/home-services/shells.scm: Replace (gnu home-services configuration) with (gnu home services configuration). Rename to gnu/home/services/shells.scm. Replace (gnu home-services utils) with (gnu home services utils). * gnu/home-services/shepherd.scm: Move to gnu/home/services/shepherd.scm. * gnu/home-services/symlink-manager.scm: Rename to gnu/home/services/symlink-manager.scm. * gnu/home-services/utils.scm: Rename to gnu/home/services/utils.scm. * gnu/home-services/xdg.scm: Rename to gnu/home/services/xdg.scm. * guix/scripts/home/import.scm: Replace (gnu home-services bash) with (gnu home services bash). * gnu/home-services.scm: Update documentation string. * doc/he-config-bare-bones.scm: Apply new (gnu home-services ...) modules location. * gnu/local.mk (GNU_SYSTEM_MODULES): Same.
2021-10-04doc: cookbook: Mention translations of the cookbook.Sarah Morgensen
* doc/guix-cookbook.texi (Top): Add note about l10n. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-04doc: Update htmlxref.cnf.Sarah Morgensen
Update and fix broken references to cuirass, git, and guix-cookbook. * doc/htmlxref.cnf: Update from Texinfo. Factorize Guix manuals. (cuirass, git, guix-cookbook, guix-cookbook.de, guix-cookbook.fr): New entries. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-04maint: Improve default diff hunk header detection.Sarah Morgensen
Tell git where to look for diff hunk headers: top-level definitions for Scheme files, and (sub)section headers for texi files. * .gitattributes, etc/git/gitconfig: New files. * doc/contributing.texi ("Submitting Patches"): Add subsection "Configuring Git". Document etc/git/gitconfig. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-10-04doc: Fix 'setuid-program' example.Maxime Devos
The '#$' doesn't belong there, and will cause ‘unbound variable’ errors. Reported-By: ss2 (on IRC) * doc/guix.texi (Setuid Programs): Remove #$ from example. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-10-04services: knot: Remove obsolete DISABLE-ANY? zone option.Tobias Geerinckx-Rice
It is now silently ignored by knotd. * gnu/services/dns.scm (<knot-zone-configuration>): Remove DISABLE-ANY? field. Adjust all previous users. * doc/guix.texi (DNS Services): Undocument it.
2021-10-02scripts: home: Wire and document --expression flag.Pierre Langlois
* guix/scripts/home.scm (show-help): Add --expression option. (%options): Likewise. * doc/guix.texi (Invoking guix home): Document it.
2021-09-29doc: Document Wireguard port configuration option.Jacob Adams
* doc/gnu.texi (VPN Services): Document wireguard port configuration option. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-09-28doc: Fix typos.Tobias Geerinckx-Rice
* doc/guix.texi (Invoking guix import): Fix ‘accross’ typo. (Version Control Services): Fix ‘infomation’ typo.
2021-09-27Merge branch 'wip-guix-home'Oleg Pykhalov
generated by cgit