summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* build-system: Add renpy-build-system.Leo Prikler2021-02-07
| | | | | | | * guix/build/renpy-build-system.scm: New file. * guix/build-system/renpy.scm: New file. * Makefile.am (MODULES): Add them here. * doc/guix.texi (Build Systems): Document renpy-build-system.
* services: postgresql: Update documented socket directory to match code.Ben Sturmfels2021-02-02
| | | | | | | | This is a follow-up of 6c0679215f4ffa534c1eb2e8c8a6e043a0c993fe. * doc/guix.texi (Database Services): Update it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* build: Add a --show-duration option to the SCM test-driver.Maxim Cournoyer2021-02-02
| | | | | | | | | | | | * build-aux/test-driver.scm (script-version): Update. (show-help): Document it. (%options): Add the 'show-duration' option. (test-runner-gnu): Pass as a new argument. [test-cases-start-time]: New inner variable. [test-on-test-begin-gnu]: New hook, used to record the start time. [test-on-test-end-gnu]: Conditionally print elapsed time. Record it as the optional metadata in the test result file (.trs). * doc/guix.texi (Running the Test Suite): Document it.
* doc: Explain how to set custom Shepherd package.Oleg Pykhalov2021-02-01
| | | | | * doc/guix.texi (Shepherd Services): Give example on how to set custom Shepherd package.
* guix package: Add '--export-channels'.Ludovic Courtès2021-02-01
| | | | | | | | | | | | | * guix/channels.scm (sexp->channel): Export. * guix/describe.scm: Use (guix channels). (manifest-entry-provenance): New procedure. * guix/scripts/package.scm (channel=?, export-channels): New procedures. (show-help, %options): Add '--export-channels'. (process-query): Honor it. * build-aux/build-self.scm (build-program)[select?]: Exclude (guix channels) to account for the (guix describe) change above. * doc/guix.texi (Invoking guix package): Document it.
* guix package: Add '--export-manifest'.Ludovic Courtès2021-02-01
| | | | | | | | | * guix/scripts/package.scm (export-manifest): New procedure. (show-help, %options): Add '--export-manifest'. (process-query): Honor it. * guix/build/profiles.scm (build-profile): Mention it. * tests/guix-package.sh: Test it. * doc/guix.texi (Invoking guix package): Document it.
* build: test-driver.scm: Add a new '--errors-only' option.Maxim Cournoyer2021-01-31
| | | | | | | | | | | * build-aux/test-driver.scm (show-help): Add the help text for the new '--errors-only' option. (%options): Add the errors-only option. (test-runner-gnu): Add the errors-only? parameter and update doc. Move the logging of the test data after the test has completed, so a choice can be made whether to keep it or discard it based on the value of the test result. (main): Pass the errors-only? option to the driver. * doc/guix.texi (Running the Test Suite): Document the new option.
* build: test-driver.scm: Add test cases filtering options.Maxim Cournoyer2021-01-31
| | | | | | | | | | | * build-aux/test-driver.scm (show-help): Add help text for the new --select and --exclude options. (%options): Add the new select and exclude options. (test-runner-gnu): Pass them to the test runner. Update doc. (test-match-name*, test-match-name*/negated, %test-match-all): New variables. (main): Compute the test specifier based on the values of the new options and apply it to the current test runner when running the test file. * doc/guix.texi (Running the Test Suite): Document the new options.
* guix: channels: Introduce "channel-with-substitutes-available".Mathieu Othacehe2021-01-31
| | | | | | | | * guix/channels.scm (find-latest-commit-with-substitutes, channel-with-substitutes-available): New procedures. * guix/scripts/pull.scm (guix-pull): Move "channel-list" call inside the %current-system parameter scope. * doc/guix.texi (Channels with substitutes): New section.
* services: shepherd: Allow custom 'shepherd' package.Maxime Devos2021-01-30
| | | | | | | | | | | | | * gnu/services/shepherd.scm (<shepherd-configuration>): New record. (shepherd-boot-gexp, shepherd-root-service-type): Use it. (scm->go, shepherd-configuration-file): Allow passing custom shepherd package. * gnu/system.scm (operating-system-shepherd-service-names): Use the new record. * guix/scripts/system.scm (export-shepherd-graph): Adjust accordingly. * doc/guix.texi (Shepherd Services). Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* build-system/julia: Don't rely on file name to set module name.nixo2021-01-30
| | | | | | | | | * guix/build/julia-build-system.scm (project.toml->name): New procedure. (precompile, check, julia-build): Accept new key argument #:julia-package-name. * guix/build-system/julia.scm (julia-build): ... add it. * doc/guix.texi (julia-build-system): Update julia-package-name accordingly. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* build-system/julia: Enable tests.nixo2021-01-30
| | | | | | | | | | * guix/build-system/julia.scm (julia-build): Set tests? default to #t. * guix/build/julia-build-system.scm (check): Respect tests? and fix julia invocation. (%standard-phases): Add check phase after install. * doc/guix.texi (julia-build-system): Update accordingly. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Update guidance about Rust package naming.Hartmut Goebel2021-01-29
| | | | | * doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning.
* doc: Fix mapped devices example in the manual.Joshua Branson2021-01-28
| | | | | | | | | Reported by Raghav Gururajan <rg@raghavgururajan.name> and Mikhail Tsykalov <tsymsh@gmail.com>. * doc/guix.texi (Mapped Devices): Replace target with targets. Signed-off-by: Leo Famulari <leo@famulari.name>
* services: postgresql: Add postgresql-role-service-type.Mathieu Othacehe2021-01-28
| | | | | | | | | | | * gnu/services/databases.scm (postgresql-role, postgresql-role?, postgresql-role-name, postgresql-role-permissions, postgresql-role-create-database?, postgresql-role-configuration, postgresql-role-configuration?, postgresql-role-configuration-host, postgresql-role-configuration-roles, postgresql-role-service-type): New procedures. * gnu/tests/databases.scm: Test it. * doc/guix.texi: Document it.
* services: postgresql: Add log directory support.Mathieu Othacehe2021-01-28
| | | | | | | | | | | * gnu/services/databases.scm (postgresql-configuration-log-directory): New procedure. (<postgresql-configuration>)[log-directory]: New field. (postgresql-activation): Create the log directory. (postgresql-shepherd-service): Honor it. * gnu/tests/databases.scm (%postgresql-log-directory): New variable. (log-file): New test case. * doc/guix.texi (Database Services): Document it.
* services: postgresql: Add socket directory support.Mathieu Othacehe2021-01-28
| | | | | | | | | | | | | | * gnu/services/databases.scm (postgresql-config-file-socket-directory): New procedure. (<postgresql-config-file>)[socket-directory]: New field. (postgresql-config-file-compiler): Honor it. (postgresql-activation): Create the socket directory if needed. * doc/guix.texi (Database Services): Document it. * gnu/tests/guix.scm (%guix-data-service-os): Adapt it. * gnu/tests/monitoring.scm (%zabbix-os): Ditto. * gnu/tests/web.scm (patchwork-os): Ditto. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* services: postgresql: Use Guile datatypes.Mathieu Othacehe2021-01-28
| | | | | | | * gnu/services/databases.scm (postgresql-config-file-compiler): Support Guile datatypes in the "extra-config" field. * gnu/tests/databases.scm (%postgresql-os): Test it. * doc/guix.texi (Database Services): Document it.
* doc: Clarify that package transformations are preserved across upgrades.Ludovic Courtès2021-01-24
| | | | | | | | | | Reported by pineapples on #guix. This is a followup to 8e1907a72430aa989125b053573ef0897c480697. * doc/guix.texi (Invoking guix package): Remove sentence that says that package transformations are lost upon upgrading and explicitly say the opposite.
* doc: Properly close sentences ending with an upper-case letter.Nicolas Goaziou2021-01-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * doc/guix.texi (Application Setup): (USB Stick and DVD Installation): (Proxy Settings): (Primary URL): (origin Reference): (Build Systems): (The Store): (Package Transformation Options): (Invoking guix lint): (Invoking guix graph): (operating-system Reference): (X Window): (Desktop Services): (Database Services): (Mail Services): (Messaging Services): (Monitoring Services): (LDAP Services): (Certificate Services): (DNS Services): (VPN Services): (Power Management Services): (Virtualization Services): (Version Control Services): (Name Service Switch): (Bootloader Configuration): (Running Guix in a VM): (Separate Debug Info): Use "@." to indicate to Texinfo the sentence does end with a capital letter.
* doc: cookbook: Add "Guix System Image API" section.Joshua Branson2021-01-21
| | | | | | * doc/guix-cookbook.texi (Guix System Image API): New section. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* doc: Replace TP with Weblate mentions.Julien Lepiller2021-01-20
| | | | | | * doc/contributing.texi: Replace link to TP with a link to Weblate. * doc/guix.texi: Replace link to TP with a link to Weblate. * doc/guix-cookbook.texi: Replace link to TP with a link to Weblate.
* transformations: Add '--with-latest'.Ludovic Courtès2021-01-19
| | | | | | | | | | | | * guix/upstream.scm (upstream-source-compiler): New procedure. (%updaters): Set! it. * guix/transformations.scm (transform-package-latest): New procedure. (%transformations): Add 'with-latest'. (%transformation-options, show-transformation-options-help/detailed): Add '--with-latest'. * tests/transformations.scm ("options->transformation, with-latest"): New test. * doc/guix.texi (Package Transformation Options): Document it.
* system: Rename 'disk-image' command 'image'.Mathieu Othacehe2021-01-19
| | | | | | | | | | | | | * guix/scripts/system.scm (system-derivation-for-action): Rename 'disk-image' command 'image'. Warn when using the now deprecated 'disk-image' command. (show-help): Adapt accordingly. (guix-system): Ditto. * tests/guix-system.sh: Ditto. * gnu/system/examples/bare-hurd.tmpl: Ditto. * doc/guix.texi (Building the Installation Image, Building the Installation Image for ARM Boards, Invoking guix pack, Invoking guix system): Adapt documentation.
* doc: Fix typo.Joshua C. Randall2021-01-19
| | | | | | | | Fixes <http://bugs.gnu.org/35004>. * doc/guix.texi (Invoking guix package): Fix typo. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* image: Rename "raw" image-type to "efi-raw".Mathieu Othacehe2021-01-17
| | | | | | | | * gnu/system/image.scm (raw-image-type): Rename to "efi-raw-image-type". * guix/scripts/system.scm (%default-options): Adapt accordingly. * doc/guix.texi: Ditto. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* services: openntpd: Remove support for deprecated "-s" option.Simon South2021-01-16
| | | | | | | | | | | | | | | * gnu/services/networking.scm (openntpd-configuration): Remove "allow-large-adjustment?" field. (openntpd-shepherd-service): Remove use of "allow-large-adjustment?" configuration field and "-s" daemon option. * tests/networking.scm (%openntpd-conf-sample): Remove "allow-large-adjustment?" field. * doc/guix.texi (Networking Services)[openntpd-service-type]: Remove "allow-large-adjustment?" field from sample configuration. [openntpd-configuration]: Remove description of "allow-large-adjustment?" field. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* services: qemu-binfmt: 'guix-support?' defaults to #t.Stefan2021-01-16
| | | | | | | | | * gnu/services/virtualization.scm (qemu-binfmt-service-type)[guix-support?]: Change the default from #f to #t. * doc/guix.texi (Transparent Emulation with QEMU): Change the default of ‘guix-support?’ from #f to #t. Describe the implication of setting it to #f. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* doc: Mention optional dependency on Guile-zstd.Ludovic Courtès2021-01-13
| | | | * doc/guix.texi (Requirements): Add Guile-zstd.
* publish: Add support for zstd compression.Ludovic Courtès2021-01-13
| | | | | | | | | | | * guix/scripts/publish.scm (compress-nar)[write-compressed-file]: New procedure. Use it for 'gzip' and 'lzip'. Add 'zstd. (nar-response-port, string->compression-type): Add case for 'zstd'. * tests/publish.scm (zstd-supported?): New procedure. ("/nar/zstd/*"): New test. * doc/guix.texi (Invoking guix publish): Document zstd compression. (Base Services): Add cross-reference to the above node.
* doc: Remove trace of ci.guix.info.Florian Pelz2021-01-12
| | | | | * doc/guix.texi (Invoking guix weather): Use default substitute server in example.
* services: Add keepalived service.Oleg Pykhalov2021-01-12
| | | | | | | * gnu/services/networking.scm (<keepalived-configuration>): New record. (keepalived-shepherd-service): New procedure. (keepalived-service-type): New variable. * doc/guix.texi (Networking Services): Document this.
* services: Add syncthing service.Oleg Pykhalov2021-01-12
| | | | | | * gnu/services/syncthing.scm: New file. * gnu/local.mk: Add this. * doc/guix.texi: Document this.
* doc: DNS Services: Fix typography.Nicolas Goaziou2021-01-12
| | | | * doc/guix.texi (DNS Services): Use appropriate Texinfo markup and capitalization.
* doc: Use two spaces after full stop.Nicolas Goaziou2021-01-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * doc/guix.texi: (GNU Distribution): (Invoking guix-daemon): (Invoking guix pull): (Invoking guix time-machine): (Specifying Additional Channels): (Build Systems): (Invoking guix refresh): (Invoking guix processes): (Mapped Devices): (Base Services): (Networking Services): (Mail Services): (Telephony Services): (Monitoring Services): (Web Services): (DNS Services): (Continuous Integration): (Audio Services): (Virtualization Services): (Version Control Services): (Guix Services): (Miscellaneous Services): (Initial RAM Disk): (Bootloader Configuration): (Invoking guix deploy): Use two spaces after full stop, as required by Texinfo syntax.
* doc: Add missing cups-filters default extension.Tobias Geerinckx-Rice2021-01-10
| | | | | * doc/guix.texi (Printing Services): Add cups-filters to the documented list of default cups-configuration extensions.
* services: cups: Add brlaser extension by default.Tobias Geerinckx-Rice2021-01-10
| | | | | | * gnu/services/cups.scm (cups-configuration): Add brlaser to the default extensions. * doc/guix.texi (Printing Services): Document it.
* doc: Link to "Keyboard Layout" in "operating-system Reference"Morgan Smith2021-01-06
| | | | | | | * doc/guix.texi (operating-system Reference): Link to the "Keyboard Layout" node. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* guix system: Add '--graph-backend'.Ludovic Courtès2021-01-04
| | | | | | | | | | | * guix/scripts/system.scm (lookup-backend): New procedure. (export-extension-graph, export-shepherd-graph): Add #:backend parameter and honor it. (show-help, %options): Add "--graph-backend". (%default-options): Add 'graph-backend'. (process-action): Pass #:backend to 'export-extension-graph' and 'export-shepherd-graph'. * doc/guix.texi (Invoking guix system): Document '--graph-backend'.
* doc: Running Guix Before It Is Installed: mention ./bootstrapRovanion Luckey2021-01-03
| | | | | | | * doc/contributing.texi (Running Guix Before It Is Installed): Instruct user to run ./bootstrap before ./configure. Signed-off-by: Jakub Kądziołka <kuba@kadziolka.net>
* services: Add radicale-service-type.Jonathan Brielmaier2020-12-27
| | | | | | | | * gnu/services/mail.scm (radicale-configuration) (radicale-configuration?): New procedures. (%default-radicale-config-file) (radicale-service-type): New variables. * doc/guix.texi: Document it.
* transformations: Add '--with-patch'.Ludovic Courtès2020-12-27
| | | | | | | | | | | | Suggested by Philippe Swartvagher <philippe.swartvagher@inria.fr>. * guix/transformations.scm (transform-package-patches): New procedure. (%transformations): Add it as 'with-patch'. (%transformation-options, show-transformation-options-help/detailed): Add '--with-patch'. * tests/transformations.scm ("options->transformation, with-patch"): New test. * doc/guix.texi (Package Transformation Options): Document it.
* ssh: Use 'guix repl' instead of 'guile'.Ludovic Courtès2020-12-23
| | | | | | | | | | | | | | | | | | | | This simplifies setup of build machines: no need to install Guile in addition to Guix, no need to set 'GUILE_LOAD_PATH' & co., leading to fewer failure modes. * guix/ssh.scm (remote-run): New procedure. (remote-daemon-channel): Use it instead of 'open-remote-pipe*'. (store-import-channel)[import]: Remove check for module availability. Add call to 'primitive-exit'. Use 'remote-run' instead of 'open-remote-pipe'. (store-export-channel)[export]: Remove check for module availability. Add calls to 'primitive-exit'. Use 'remote-run' instead of 'open-remote-pipe'. (handle-import/export-channel-error): Remove 'module-error' clause. (report-module-error): Remove. * guix/scripts/offload.scm (assert-node-has-guix): Replace call to 'report-module-error' by 'leave'. * doc/guix.texi (Daemon Offload Setup): Remove mention of Guile.
* doc: cookbook: Fix "fiction-less" typo.Pierre Neidhardt2020-12-23
| | | | | * doc/guix-cookbook.texi (Guix Profiles in Practice): Change "friction-less" to "frictionless".
* import/cran: Add input style "specification".Ricardo Wurmus2020-12-22
| | | | | | | | | * guix/import/cran.scm (%input-style): New parameter. (format-inputs): Use it. * guix/scripts/import/cran.scm (guix-import-cran): Set the %input-style parameter. (%options): Add "--style" option. * doc/guix.texi (Invoking guix import): Document it.
* doc: Emacs Packages: Fix typos.Nicolas Goaziou2020-12-17
| | | | | * doc/contributing.texi (Emacs Packages): Fix typo. Also remove spurious white space, and unnecessary quote.
* doc: Add Emacs packaging guidelines.Maxim Cournoyer2020-12-17
| | | | * doc/contributing.texi (Emacs Packages): New subsection.
* doc: Note different texlive-tiny & texline-union natures.Tobias Geerinckx-Rice2020-12-14
| | | | | | | * doc/contributing.texi (Submitting Patches): Add ‘package’ and ‘procedure’. Inspired-by: Jorge P. de Morais Neto
* doc: Link to "Pattern Matching" in Guile.Ludovic Courtès2020-12-14
| | | | | * doc/contributing.texi (Data Types and Pattern Matching): Link to the "Pattern Matching" node of the Guile manual.
* doc: Document 'advertise?' for 'guix-publish-configuration'.Ludovic Courtès2020-12-09
| | | | | * doc/guix.texi (Base Services): Document the 'advertise?' field of 'guix-publish-configuration'.