aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-03-15doc: Clarify and consolidate modify-services documentation.Chris Marusich
* doc/guix.texi ("Using the Configuration System"): Move the example... ("Service Reference"): ...to here, and clarify more. * gnu/services.scm (modify-services): Update docstring to mention the return type. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2016-03-15doc: Add "Hardware Considerations" node.Ludovic Courtès
Suggested by Nils Gillmann <niasterisk@grrlz.net>. * doc/guix.texi (Hardware Considerations): New node. (operating-system Reference): Mention it.
2016-03-14doc: Fix incorrect use of @xref.Andreas Enge
This is a follow-up to commit 1068f26b797ed7c1475d93cab6eed53c9097c7f6. Reported by Alex Kost <alezost@gmail.com>. * doc/guix.texi (Building the Installation Image): Replace @xref by @ref.
2016-03-14build: Add Ant build system.Ricardo Wurmus
* guix/build-system/ant.scm: New file. * guix/build/ant-build-system: New file. * Makefile.am (MODULES): Add new files. * doc/guix.texi (Build Systems): Document ant-build-system.
2016-03-11doc: Add footnote about pointing ~/.config/guix/latest at user's checkoutChristopher Allan Webber
* doc/contributing.texi (Running Guix Before It Is Installed): New footnote.
2016-03-11doc: Suggest `guix.scm' for upstream maintainers.Jan Nieuwenhuizen
* doc/guix.texi (Invoking guix package): Suggest `guix.scm'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2016-03-10substitute: Add HTTPS support.Ludovic Courtès
Fixes <http://bugs.gnu.org/22937>. Reported by Chris Marusich <cmmarusich@gmail.com>. * guix/scripts/substitute.scm (fetch): Add 'https' alongside 'http'. Use 'open-connection-for-uri' instead of 'open-socket-for-uri'. Call 'setvbuf' only when PORT matches 'file-port?'. (http-multiple-get): Likewise. Change 'base-url' parameter to 'base-uri'. (fetch-narinfos)[do-fetch]: Add 'https' case alongside 'http'. Pass URI instead of URL to 'http-multiple-get'. * doc/guix.texi (Requirements): Move GnuTLS one level higher and mention HTTPS substitutes. (Substitutes): Mention HTTPS and recommend it. Explain why servers are not authenticated. Add "On Trusting Binaries" subsection.
2016-03-09doc: Add note on store immutability.Ludovic Courtès
* doc/guix.texi (The Store): Mention "store items" and the database location. Add note on the store's immutability.
2016-03-08guix build: Add '--quiet'.Ludovic Courtès
Fixes <http://bugs.gnu.org/19772>. Reported by Andrei Osipov <andrspv@gmail.com>. * guix/scripts/build.scm (show-help, %options): Add --quiet. (guix-build): Parameterize 'current-build-output-port' accordingly. * doc/guix.texi (Invoking guix build): Use it in example. (Additional Build Options): Document it.
2016-03-05doc: Explain how to check whether security updates are used.Ludovic Courtès
Based on <https://lists.gnu.org/archive/html/guix-devel/2016-03/msg00009.html>. * doc/guix.texi (Security Updates): Explain how to check whether we're using a grafted version.
2016-03-05doc: Typos and small stylistic changes.Andreas Enge
* guix.texi: Correct typos and make minor changes.
2016-03-04doc: Mention syslogd configuration.Ludovic Courtès
* gnu/services/base.scm (syslog-service): Add xref to Inetutils in the docstring. (%default-syslog.conf): Export. * doc/guix.texi (Base Services): Update accordingly.
2016-03-03doc: Improve Info categories.Ludovic Courtès
* doc/guix.texi: Change main category to "System administration". Fix syntax of subnodes. Add entries for 'guix pull' and 'guix gc'. Add "Emacs" category.
2016-03-02utils: Use '@' for separating package names and version numbers.Mathieu Lirzin
This provides the ability to use numbers in package names. Fixes <http://bugs.gnu.org/19219>. * guix/utils.scm (package-name->name+version): New procedure. * gnu/packages.scm (%find-package): Add a FALLBACK? keyword argument. Use the previous method when no package is found. (specification->package+output, specification->package): Adapt documentation to new syntax. * doc/guix.texi (Invoking guix package, Invoking guix import): Likewise. * guix/ui.scm (package-specification->name+version+output): Likewise. * guix/scripts/import/hackage.scm (show-help): Likewise. * tests/guix-build.sh: Adapt to new syntax. * tests/guix-lint.sh: Likewise. * tests/guix-package.sh: Likewise. * tests/ui.scm ("package-specification->name+version+output"): Likewise. * tests/utils.scm ("package-name->name+version"): Likewise. * NEWS: Mention new syntax.
2016-03-02guix build: Move '--no-grafts' to the common build options.Ludovic Courtès
* guix/scripts/build.scm (%options): Move --no-grafts to... (%standard-build-options): ... here. (show-help, show-build-options-help): Adjust accordingly. * guix/scripts/archive.scm (%default-options): Add 'graft?'. (guix-archive): Parametrize '%graft?'. * guix/scripts/environment.scm (%default-options): Add 'graft?'. (guix-environment): Parametrize '%graft?'. * guix/scripts/package.scm (%default-options): Add 'graft?'. (guix-package): Parametrize '%graft?'. * guix/scripts/system.scm (%default-options): Add 'graft?'. (guix-system): Parametrize 'graft?'. * doc/guix.texi (Additional Build Options): Move --no-grafts to... (Common Build Options): ... here.
2016-03-01grafts: Graft recursively.Ludovic Courtès
Fixes <http://bugs.gnu.org/22139>. * guix/grafts.scm (graft-derivation): Rename to... (graft-derivation/shallow): ... this. (graft-origin-file-name, item->deriver, non-self-references) (cumulative-grafts, graft-derivation): New procedures * tests/grafts.scm ("graft-derivation, grafted item is a direct dependency"): Clarify title. Use 'grafted' instead of 'graft' to refer to the grafted derivation. ("graft-derivation, grafted item is an indirect dependency") ("graft-derivation, no dependencies on grafted output"): New tests. * guix/packages.scm (input-graft): Change to take a package instead of an input. (input-cross-graft): Likewise. (fold-bag-dependencies): New procedure. (bag-grafts): Rewrite in terms of 'fold-bag-dependencies'. * tests/packages.scm ("package-derivation, indirect grafts"): Comment out. * doc/guix.texi (Security Updates): Mention run-time dependencies and recursive grafting.
2016-02-26import: Add github-updater.Ben Woodcroft
* guix/import/github.scm: New file. * guix/scripts/refresh.scm (%updaters): Add %GITHUB-UPDATER. * doc/guix.texi (Invoking guix refresh): Mention it. * Makefile.am (MODULES): Add gnu/import/github.scm.
2016-02-26doc: Capitalize section title.Ludovic Courtès
* doc/guix.texi (Running GuixSD in a VM): Capitalize section title.
2016-02-25Merge branch 'media-updates'Mark H Weaver
2016-02-25doc: Clarify the form of UUIDs we expect.Ludovic Courtès
Fixes <http://bugs.gnu.org/22797>. Reported by Alex Kost <alezost@gmail.com>. * doc/guix.texi (File Systems): Clarify which UUIDs we're talking about.
2016-02-25store: Clarify documentation of 'valid-path?'.Ludovic Courtès
* guix/store.scm (valid-path?): Improve docstring. * doc/guix.texi (The Store): Update accordingly.
2016-02-24doc: Improve recent changes in "Binary Installation".Ludovic Courtès
This amends part of c8e2688. * doc/guix.texi (Binary Installation): Improve wording of some parts. Fix Upstart example. Remove incorrect paragraph about locales. Reinstate bit about reproducing the binary tarball.
2016-02-24doc: Clarify who can run 'guix pull'.Ludovic Courtès
Suggested by Chris Marusich <cmmarusich@gmail.com>. * doc/guix.texi (Invoking guix pull): Add paragraph explaining that any user can run 'guix pull'.
2016-02-24doc: Add details for binary installation.George Clemmer
* doc/guix.texi (Binary Installation): Provide some more details for binary installation, in particular automatic starting of the daemon. Signed-off-by: Andreas Enge <andreas@enge.fr>
2016-02-24doc: Fix minor typos and add missing words.Chris Marusich
* doc/guix.texi (Shepherd Services): Add missing words. (Invoking guix system): Fix typo. (Service Types and Services): Fix typo. * doc/contributing.texi (Submitting Patches): Fix typo. Signed-off-by: Andreas Enge <andreas@enge.fr>
2016-02-24gnu-maintenance: Add X.org updater.Andy Wingo
* guix/gnu-maintenance.scm (xorg-package?, latest-xorg-release): New private functions. (%xorg-updater): New public variable. * guix/scripts/refresh.scm (%updaters): Add %xorg-updater. * doc/guix.texi (Invoking guix refresh): Mention the new updater.
2016-02-23doc: Add example of VCS-snapshot version numbers.Ludovic Courtès
* doc/guix.texi (Version Numbers): Add example for VCS version numbers.
2016-02-22emacs: Add 'M-x guix-installed-{user/system}-packages'.Alex Kost
* emacs/guix-ui-package.el (guix-installed-user-packages) (guix-installed-system-packages): New commands. * doc/emacs.texi (Emacs Commands): Document them.
2016-02-21doc: Add Texinfo HTML cross-reference file.Ludovic Courtès
Fixes <http://bugs.gnu.org/22543>. * doc/htmlxref.cnf: New file. * doc.am (EXTRA_DIST): Add it.
2016-02-21Revert "doc: Drop documentation of deprecated procedures."Andreas Enge
This reverts commit f5c6e77a7f42e133df8c97d3b4798a11e6d58d06.
2016-02-20import: gem: Add updater.Ben Woodcroft
* guix/import/gem.scm (guix-package->gem-name, gem-package?, latest-release): New procedures. (%gem-updater): New variable. (rubygems-fetch): Wrap body in 'call-with-output-file' and 'with-error-to-port'. * guix/scripts/refresh.scm (%updaters): Add %GEM-UPDATER. * doc/guix.texi (Invoking guix refresh): Mention RubyGems.
2016-02-16doc: Add footnote on Guile-JSON.Andreas Enge
* doc/guix.texi ("invoking guix import"): Add a footnote to the CPAN importer on the need for Guile-JSON.
2016-02-16doc: Drop documentation of deprecated procedures.Andreas Enge
* doc/guix.texi ("build systems"): Drop documentation of BUILD-EXPRESSION->DERIVATION.
2016-02-16doc: Use modify-phases syntax in example.Andreas Enge
* doc/guix.texi ("build systems"): Use modify-phases syntax instead of alist-delete in example.
2016-02-16doc: Move paragraphs in description of guix archive.Andreas Enge
* doc/guix.texi ("invoking guix archive"): Move paragraph describing basic invocation from the end to the beginning of the section.
2016-02-13doc: Correct typos.Andreas Enge
* doc/guix.texi: Correct typos, grammar and stylistic points.
2016-02-12scripts: environment: Build environments as profiles.David Thompson
Fixes <http://bugs.gnu.org/19816>. * guix/scripts/environment.scm (evaluate-input-search-paths) (build-inputs): Delete. (evaluate-profile-search-paths, strip-input-name) (package-or-package+output?, package-environment-inputs) (build-environment, inputs->profile-derivations): New procedures. (create-environment, show-search-paths, launch-environment) (launch-environment/container): Replace 'inputs' argument with 'profile' argument. (package+propagated-inputs): Strip off names off of input tuples. (options/resolve-packages): Handle input tuples that specify an output in expressions. (guix-environment): Convert inputs into a profile to use in the environment. Remove non-package inputs such as origins from environment inputs. * doc/guix.texi ("invoking guix environment"): Document package+output tuples for --expression option. * tests/guix-environment.sh: Update tests. * tests/guix-environment-container.sh: Likewise. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2016-02-10doc: Provide more details about system installation.Ludovic Courtès
* doc/guix.texi (System Installation): Turn all subsections into individual nodes. (Limitations): Update the number of packages. (Preparing for Installation)[Keyboard Layout, Networking, Disk Partitionning]: New subsections. Move the 'cow-store' thing to... (Proceeding with the Installation): ... here. Describe things in more detail. (Base Services): Add index entry for "keyboard layout". Co-authored-by: Petter <petter@mykolab.ch>.
2016-02-10system: Selected locale is automatically built.Ludovic Courtès
Fixes <http://bugs.gnu.org/22572>. Reported by Mark H Weaver <mhw@netris.org>. * gnu/system/locale.scm (%not-dot): New variable. (denormalize-codeset, locale-name->definition): New procedures. * gnu/system.scm (locale-name->definition*): New procedure. (operating-system-locale-directory): Instead of raising an error, add the missing locale. * doc/guix.texi (Locales): Adjust accordingly.
2016-02-10emacs: 'C-u M-x guix-edit' prompts for directory.Alex Kost
* emacs/guix-base.el (guix-read-directory): New procedure. (guix-find-location, guix-edit): Add optional 'directory' argument. * emacs/guix-ui-package.el (guix-package-list-edit) (guix-output-list-edit): Likewise. * doc/emacs.texi (Emacs Commands): Mention "C-u".
2016-02-07doc: Document 'guix-edit' Emacs command.Alex Kost
* doc/emacs.texi (Emacs Commands): Document "M-x guix-edit". * doc/guix.texi (Invoking guix edit): Mention it.
2016-02-07emacs: Factorize searching for Emacs packages.Alex Kost
* emacs/guix-emacs.el: (guix-emacs-directories): New procedure. (guix-emacs-find-autoloads-in-directory): Rename to... (guix-emacs-find-autoloads): ... this. (guix-emacs-load-autoloads): Remove. Replace with... (guix-emacs-autoload-packages): ... this. New procedure. At first, find a list of directories with Emacs packages, then add them to 'load-path' and finally, load autoloads. * doc/emacs.texi (Emacs Initial Setup): Adjust accordingly.
2016-02-04doc: Mention 'tzselect'.Ludovic Courtès
* doc/guix.texi (operating-system Reference): Mention 'tzselect' and invalid timezone strings.
2016-02-03guix system: 'reconfigure' loads and starts new services.Ludovic Courtès
Partly fixes <http://bugs.gnu.org/22039>. * gnu/services/herd.scm: New file. * gnu-system.am (GNU_SYSTEM_MODULES): Add it. * gnu/services/shepherd.scm (shepherd-service-canonical-name): New procedure. (shepherd-service-file): Export. * guix/scripts/system.scm (upgrade-shepherd-services): New procedure. (switch-to-system): Use it. * guix/ui.scm (info): New procedure. * doc/guix.texi (Invoking guix system): Mention system services.
2016-02-01guix build: Add '--with-input'.Ludovic Courtès
* guix/scripts/build.scm (transform-package-inputs): New procedure. (%transformations): Add it. (%transformation-options, show-transformation-options-help): Add --with-input. * tests/scripts-build.scm ("options->transformation, with-input"): ("options->transformation, with-input, no matches"): New tests. * tests/guix-build.sh: Add tests. * doc/guix.texi (Package Transformation Options): Document it.
2016-02-01guix package: Support package transformation options.Ludovic Courtès
* guix/scripts/package.scm (show-help): Call 'show-transformation-options-help'. (%options): Append %TRANSFORMATION-OPTIONS. (process-actions)[transform, transform-entry]: New procedures. * doc/guix.texi (Invoking guix package): Mention package transformations. (Package Transformation Options): Mention 'guix package'.
2016-02-01guix build: Separate transformation options.Ludovic Courtès
* guix/scripts/build.scm (%transformation-options): New variable. (show-transformation-options-help): New procedure. (show-help): Remove '--with-source' documentation and add 'show-transformation-options-help' call. (%options): Remove "with-source" and append %TRANSFORMATION-OPTIONS. * doc/guix.texi (Package Transformation Options): New node. Document '--with-source', moved from... (Additional Build Options): ... here.
2016-02-01doc: Add subsections to 'Invoking guix build'.Ludovic Courtès
* doc/guix.texi (Invoking guix build): Add example. Shuffle options in the new subsections below. (Common Build Options, Additional Build Options): New nodes. (Invoking guix archive): Refer to "Common Build Options". (Invoking guix environment): Likewise. (Invoking guix system): Likewise. fixlet
2016-01-29guix system: Rename 'dmd-graph' to 'shepherd-graph'.Alex Kost
* doc/images/dmd-graph.dot: Rename to... * doc/images/shepherd-graph.dot: ... this. * doc.am (DOT_FILES): Adjust accordingly. * guix/scripts/system.scm (dmd-service-node-label) (dmd-service-node-type, export-dmd-graph): Rename to... (shepherd-service-node-label, shepherd-service-node-type) (export-shepherd-graph): ... this. (show-help, process-action, process-command): Rename 'dmd-graph' to 'shepherd-graph'. * emacs/guix-command.el (guix-command-additional-execute-arguments) (guix-command-special-executors): Likewise. * doc/guix.texi: Likewise. * doc/emacs.texi (Emacs Popup Interface): Likewise.
2016-01-29services: Rename 'dmd' services to 'shepherd'.Alex Kost
* gnu/services/shepherd.scm (dmd-root-service-type, %dmd-root-service) (dmd-service-type, <dmd-service>, dmd-service, dmd-service?) (make-dmd-service, dmd-service-documentation, dmd-service-provision) (dmd-service-requirement, dmd-service-respawn, dmd-service-start) (dmd-service-stop, dmd-service-auto-start?, dmd-service-modules) (dmd-service-imported-modules, dmd-service-file-name, dmd-service-file) (dmd-service-back-edges): Rename to... (shepherd-root-service-type, %shepherd-root-service, shepherd-service-type) (<shepherd-service>, shepherd-service, shepherd-service?) (make-shepherd-service, shepherd-service-documentation) (shepherd-service-provision, shepherd-service-requirement) (shepherd-service-respawn, shepherd-service-start) (shepherd-service-stop, shepherd-service-auto-start?) (shepherd-service-modules, shepherd-service-imported-modules) (shepherd-service-file-name, shepherd-service-file) (shepherd-service-back-edges): ...this * gnu/services.scm: Adjust comments. * gnu/services/avahi.scm (avahi-dmd-service): Rename to... (avahi-shepherd-service): ... this. * gnu/services/base.scm (%root-file-system-dmd-service) (file-system->dmd-service-name, mapped-device->dmd-service-name) (dependency->dmd-service-name, file-system-dmd-service) (mingetty-dmd-service, nscd-dmd-service, guix-dmd-service) (guix-publish-dmd-service, udev-dmd-service, gpm-dmd-service): Rename to... (%root-file-system-shepherd-service) (file-system->shepherd-service-name, mapped-device->shepherd-service-name) (dependency->shepherd-service-name, file-system-shepherd-service) (mingetty-shepherd-service, nscd-shepherd-service, guix-shepherd-service) (guix-publish-shepherd-service, udev-shepherd-service) (gpm-shepherd-service): ... this. * gnu/services/databases.scm (postgresql-dmd-service): Rename to... (postgresql-shepherd-service): ... this. * gnu/services/desktop.scm (upower-dmd-service, elogind-dmd-service): Rename to... (upower-shepherd-service, elogind-shepherd-service): ... this. * gnu/services/dbus.scm (dbus-dmd-service): Rename to... (dbus-shepherd-service): ... this. * gnu/services/lirc.scm (lirc-dmd-service): Rename to... (lirc-shepherd-service): ... this. * gnu/services/mail.scm (dovecot-dmd-service): Rename to... (dovecot-shepherd-service): ... this. * gnu/services/networking.scm (ntp-dmd-service, tor-dmd-service) (bitlbee-dmd-service, wicd-dmd-service, network-manager-dmd-service): Rename to... (dbus-shepherd-service): ... this. * gnu/services/ssh.scm (lsh-dmd-service): Rename to... (lsh-shepherd-service): ... this. * gnu/services/web.scm (nginx-dmd-service): Rename to... (nginx-shepherd-service): ... this. * gnu/services/xorg.scm (slim-dmd-service): Rename to... (slim-shepherd-service): ... this. * gnu/system.scm (essential-services): Use '%shepherd-root-service'. * gnu/system/install.scm (cow-store-service-type): Adjust accordingly. * guix/scripts/system.scm (dmd-service-node-label, dmd-service-node-type) (export-dmd-graph): Likewise. * tests/guix-system.sh: Likewise. * tests/services.scm ("dmd-service-back-edges"): Rename to... ("shepherd-service-back-edges"): Adjust accordingly. * doc/guix.texi: Likewise. * doc/images/service-graph.dot: Use 'shepherd' service name.