summary refs log tree commit diff
path: root/doc.am
AgeCommit message (Collapse)Author
2016-03-20build: Rewrite comments for man pages.Mathieu Lirzin
* doc.am <Man pages>: Rewrite comments to describe the build process and the meaning of the noticeable idiosyncrasies in a more general way.
2016-03-20build: Build man pages in $(srcdir).Mathieu Lirzin
Before that the doc/guix.1 rule was always triggered when doing a VPATH build from a tarball. * doc.am (sub_commands_mans, dist_man1_MANS): man pages are now generated in $(srcdir) like the info manual. (doc/guix.1, doc/guix-%.1): Prepend $(srcdir) to target name. [BUILD_DAEMON] (doc/guix-daemon.1): Likewise.
2016-03-20build: Make 'guix' man page depend on scripts/guix.in.Mathieu Lirzin
* doc.am (doc/guix.1): Add scripts/guix.in prerequisite.
2016-03-20Revert "build: Do not remake doc/guix.1."Mathieu Lirzin
This reverts commit 97966e6d65bd3d450f12c7bb41af5f9eafd35a60.
2016-03-16build: Do not remake doc/guix.1.Eric Bavier
* doc.am (doc/guix.1): Do not depend on $(sub_commands_mans) which will always appear out-of-date.
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-01build: Use the right section and source for man pages.Ludovic Courtès
* doc.am (HELP2MANFLAGS): New variable. (gen_man): Use it.
2016-01-29build: Generate man pages after compiling Guile objects.Eric Bavier
This reduces compilation time since scripts are not compiled twice. When building with 'make -j4' from a clean repository on an Intel i5-2540M, compilation time gets from: real 4m48.708s user 17m29.892s sys 0m9.596s down to: real 2m23.399s user 6m48.604s sys 0m6.420s * doc.am (subcommand-manual-target): Delete function. (SUBCOMMANDS): Delete variable. (sub_command_mans, gen_man): New variables. (dist_man1_MANS): Add $(sub_commands_mans). (doc/guix-%.1): New target for sub-commands man pages. It ensures that man pages are built only after compiling Guile objects. (doc/guix-daemon.1): Use $(gen_man). Build only if BUILD_DAEMON. (doc/guix.1): Use $(gen_man). Add $(sub_command_mans) prerequisite. Co-authored-by: Mathieu Lirzin <mthl@gnu.org>
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-28build: Use 'GEN' and 'at' silent rules.Mathieu Lirzin
* daemon.am (nix/libstore/schema.sql.hh, etc/guix-daemon.service) (etc/guix-daemon.conf): Use $(AM_V_GEN). * doc.am (doc/os-config-%.texi, .png.eps): Likewise. * Makefile.am (guix-binary.%.tar.xz, gen-ChangeLog, gen-AUTHORS): Likewise. (assert-binaries-available, assert-final-inputs-self-contained) (assert-no-store-file-names, sync-descriptions): Use $(AM_V_at).
2016-01-28build: Add 'HELP2MAN' silent rule.Mathieu Lirzin
* Makefile.am (AM_V_HELP2MAN, AM_V_HELP2MAN_, AM_V_HELP2MAN_0): New variables. * doc.am (subcommand-manual-target, doc/guix.1, doc/guix-daemon.1): Use $(AM_V_HELP2MAN).
2016-01-28build: Add 'DOT' silent rule.Mathieu Lirzin
* Makefile.am (AM_V_DOT, AM_V_DOT_, AM_V_DOT_0): New variables. * doc.am (.dot.png, .dot.pdf, .dot.eps): Use $(AM_V_DOT).
2016-01-12doc: Show bootstrapping at the package level.Ludovic Courtès
* doc/images/bootstrap-packages.dot: New file. * doc.am (DOT_FILES): Add it. * doc/guix.texi (Bootstrapping): Show 'guix graph' commands. Includes 'images/bootstrap-packages' and comment it.
2016-01-10build: Fix out-of-tree building of documentation.Taylan Ulrich Bayırlı/Kammer
* doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2015-10-20Add 'guix challenge'.Ludovic Courtès
* guix/scripts/challenge.scm, tests/challenge.scm: New files. * Makefile.am (MODULES): Add the former. (SCM_TESTS): Add the latter. * doc.am (SUBCOMMANDS): Add 'challenge'. * doc/guix.texi (Substitutes): Add xref to 'guix challenge'. (Invoking guix challenge): New node. * doc/contributing.texi (Submitting Patches): Add note about using 'guix challenge'. * po/guix/POTFILES.in: Add guix/scripts/challenge.scm.
2015-10-14guix system: Add 'dmd-graph' command.Ludovic Courtès
* guix/scripts/system.scm (dmd-service-node-label, dmd-service-node-type, export-dmd-graph): New procedures. (show-help): Add 'dmd-graph'. (guix-system)[parse-sub-command]: Likewise. Honor it. * doc/guix.texi (Invoking guix system): Document it. (dmd Services): Add an illustration and explanation. * doc/images/dmd-graph.dot: New file. * doc.am (DOT_FILES): Add it.
2015-10-10services: Introduce extensible services.Ludovic Courtès
This patch rewrites GuixSD services to make them extensible. * gnu-system.am (GNU_SYSTEM_MODULES): Add gnu/services/dbus.scm. * gnu/services.scm (<service>): Replace with new record type. (<service-extension>, <service-type>): New record types. (write-service-type, compute-boot-script, second-argument): New procedures. (%boot-service, boot-service-type): New variables. (file-union, directory-union, modprobe-wrapper, activation-service->script, activation-script, gexps->activation-gexp): New procedures. (activation-service-type, %activation-service): New variables. (etc-directory, files->etc-directory, etc-service): New procedures. (etc-service-type, setuid-program-service, firmware-service-type): New variables. (firmware->activation-gexp): New procedure. (&service-error, &missing-target-service-error, &ambiguous-target-service-error): New condition types. (service-back-edges, fold-services): New procedures. * gnu/services/avahi.scm (<avahi-configuration>): New record type. (configuration-file): Replace keyword parameters with a single 'config' parameter. (%avahi-accounts, %avahi-activation, avahi-service-type): New variables. (avahi-dmd-service): New procedure. (avahi-service): Rewrite using 'service' and 'avahi-configuration'. * gnu/services/base.scm (%root-file-system-dmd-service, root-file-system-service-type): New variables. (root-file-system-service): Use them. (file-system->dmd-service-name): New procedure. (file-system-service-type): New variable. (file-system-service): Use it. Replace keyword parameters with a single 'file-system' object. (user-unmount-service-type): New variable. (user-unmount-service): Use it. (user-processes-service-type): New variable. (user-processes-service): Use it. (host-name-service-type): New variable. (host-name-service): Use it. (console-keymap-service-type): New variable. (console-keymap-service): Use it. (console-font-service-type): New variable. (console-font-service): Use it. (mingetty-pam-service, mingetty-dmd-service): New procedures. (mingetty-service-type): New variable. (mingetty-service): Use it. (nscd-dmd-service): New procedure. (nscd-activation, nscd-service-type): New variables. (nscd-service): Use the latter. (syslog-service-type): New variable. (syslog-service): Use it. (<guix-configuration>): New record type. (%default-guix-configuration): New variable. (guix-dmd-service, guix-accounts, guix-activation): New procedures. (guix-service-type): New variable. (guix-service): Replace list of keyword parameters with a single 'config' parameter. Rewrite using 'service'. (<udev-configuration>): New record type. (udev-dmd-service): New procedure. (udev-service-type): New variable. (udev-service): Use it. (device-mapping-service-type): New variable. (device-mapping-service): Use it. (swap-service-type): New variable. (swap-service): Use it. * gnu/services/databases.scm (<postgresql-configuration>): New record type. (%postgresql-accounts, postgresql-activation): New variables. (postgresql-dmd-service): New procedure. (postgresql-service): Rewrite using 'service' and 'postgresql-configuration'. * gnu/services/dbus.scm: New file. * gnu/services/desktop.scm (dbus-configuration-directory, dbus-service): Remove. (wrapped-dbus-service): New procedure. (<upower-configuration>): New record type. (upower-configuration-file): Replace keyword parameters with single <upower-configuration> parameter. (%upower-accounts, %upower-activation): New variables. (upower-dbus-service, upower-dmd-service): New procedures. (upower-service-type): New variable. (upower-service): Rewrite using 'service' and 'upower-configuration'. (%colord-activation, %colord-accounts): New variables. (colord-dmd-service): New procedure. (colord-service-type): New variable. (colord-service): Rewrite using 'service'. (<geoclue-configuration>): New record type. (geoclue-configuration-file): Replace keyword parameters with a single 'config' parameter. (geoclue-dbus-service, geoclue-dmd-service): New procedures. (%geoclue-accounts, geoclue-service-type): New variables. (geoclue-service): Rewrite using 'service' and 'geoclue-configuration'. (%polkit-accounts, %polkit-pam-services, polkit-service-type): New variables. (polkit-dmd-service): New procedure. (polkit-service): Rewrite using 'service'. (<elogind-configuration>)[elogind]: New field. (elogind-dmd-service): New procedure. (elogind-service-type): New variable. (elogind-service): Rewrite using 'service'. (%desktop-services): Remove argument to 'dbus-service'. Remove 'map' over %BASE-SERVICES. * gnu/services/dmd.scm (dmd-boot-gexp): New procedure. (dmd-root-service-type, %dmd-root-service): New variables. (dmd-service-type): New macro. (<dmd-service>): New record type. * gnu/services/lirc.scm (<lirc-configuration>): New record type. (%lirc-activation): New variable. (lirc-dmd-service): New procedure. (lirc-service-type): New variable. (lirc-service): Rewrite using 'service' and 'lirc-configuration'. * gnu/services/networking.scm (<static-networking>): New record type. (static-networking-service-type): New variable. (static-networking-service): Rewrite using 'service' and 'static-networking'. (dhcp-client-service-type): New variable. (dhcp-client-service): Rewrite using 'service'. (<ntp-configuration>): New record type. (ntp-dmd-service): New procedure. (ntp-service-type): New variable. (ntp-service): New procedure. (%tor-accounts, tor-service-type): New variable. (tor-dmd-service): New procedure. (tor-service): Rewrite using 'service'. (<bitlbee-configuration>): New record type. (bitlbee-dmd-service): New procedure. (%bitlbee-accounts, %bitlbee-activation, bitlbee-service-type): New variables. (bitlbee-service): Rewrite using 'service'. (%wicd-activation): New variable. (wicd-dmd-service): New procedure. (wicd-service-type): New variable. (wicd-service): Rewrite using 'service'. * gnu/services/ssh.scm (<lsh-configuration>): New record type. (activation): Rename to... (lsh-initialization): ... this. (lsh-activation, lsh-dmd-service, lsh-pam-services): New procedures. (lsh-service-type): New variable. (lsh-service): Rewrite using 'service' and 'lsh-configuration'. * gnu/services/web.scm (<nginx-configuration>): New record type. (%nginx-accounts): New variable. (nginx-activation, nginx-dmd-service): New procedures. (nginx-service-type): New variable. (nginx-service): Rewrite using 'service' and 'nginx-configuration'. * gnu/services/xorg.scm (<slim-configuration>): New record type. (slim-pam-service, slim-dmd-service): New procedures. (slim-service-type): New variable. (slim-service): Rewrite using 'service' and 'slim-configuration'. * gnu/system.scm (file-union): Remove. (other-file-system-services): Adjust to new 'file-system-service' signature. (essential-services): Add #:container? parameter. Add %DMD-ROOT-SERVICE, %ACTIVATION-SERVICE, and calls to 'pam-root-service', 'account-service', 'operating-system-etc-service', and a SETUID-PROGRAM-SERVICE instance. (operating-system-services): Pass #:container? to 'essential-services. (etc-directory): Remove. (operating-system-etc-service): New procedure. Rewrite as a call to 'etc-service'. (operating-system-accounts): Change to not return accounts required by services. (operating-system-etc-directory): Rewrite as a call to 'fold-services' and 'etc-directory'. (user-group->gexp, user-account->gexp, modprobe-wrapper): Remove. (operating-system-activation-script): Rewrite as a call to 'fold-services' and 'activation-service->script'. (operating-system-boot-script): Likewise. (operating-system-derivation): Add call to 'lower-object'. (emacs-site-file, emacs-site-directory, shells-file): Change to use 'computed-file' and 'scheme-file' instead of the monadic procedures. * gnu/system/install.scm (cow-store-service-type): New variable. (cow-store-service): Rewrite using 'service'. (/etc/configuration-files): New procedure. (configuration-template-service-type, %configuration-template-service): New variables. (configuration-template-service): Remove. (installation-services): Adjust accordingly. Adjust argument to 'guix-service'. * gnu/system/linux.scm (/etc-entry, pam-root-service): New procedures. (pam-root-service-type): New variable. * gnu/system/shadow.scm (user-group->gexp, user-account->gexp, account-activation, etc-skel, account-service): New procedures. (account-service-type): New variable. * tests/services.scm: New file. * doc/guix.texi (Base Services, Desktop Services): Adjust accordingly. (Defining Services): Rewrite. * doc/images/service-graph.dot: New file. * doc.am (DOT_FILES): Add it. * po/guix/POTFILES.in: Add gnu/services.scm.
2015-08-27Add 'guix graph'.Ludovic Courtès
* guix/scripts/graph.scm, tests/graph.scm, tests/guix-graph.sh, doc/images/coreutils-bag-graph.dot, doc/images/coreutils-graph.dot: New files. * Makefile.am (MODULES): Add guix/scripts/graph.scm. (SH_TESTS): Add tests/guix-graph.sh. (SCM_TESTS): Add tests/graph.scm. * doc.am (DOT_FILES, DOT_VECTOR_GRAPHICS): New variables. (EXTRA_DIST): Use them. (dist_infoimage_DATA): Use $(DOT_FILES). (pdf-local, info-local, ps-local): Likewise. * doc/guix.texi (Packages with Multiple Outputs): Add cross-reference to 'guix graph'. (Invoking guix gc): Likewise. (Invoking guix graph): New section.
2015-08-19scripts: package: Add --install-from-file option.David Thompson
* guix/scripts/package.scm (show-help): Add help text for --install-from-file option. (%options): Add --install-from-file option. * tests/guix-package.sh: Test it. * doc/guix.texi ("invoking guix package"): Document it. * doc/package-hello.scm: New file. * doc.am (EXTRA_DIST): Add it.
2015-07-19build: Ensure man pages are not rebuilt by users.Ludovic Courtès
* doc.am (doc/guix.1): Remove dependency on 'scripts/guix' since every user would end up rebuilding 'guix.1'. Add dependency on guix/scripts/*.scm. (doc/guix-daemon.1): For the same reason, depend on 'guix-daemon.cc' instead of 'guix-daemon'. (doc/guix-$(1).1): Similarly, remove dependency on 'scripts/guix' and depend on 'guix/scripts/$(1).scm' instead of the .go file.
2015-07-19build: Build coreutils-size-map.eps for the sake of the PS and DVI outputs.Ludovic Courtès
* doc.am (EXTRA_DIST): Add coreutils-size-map.eps. (.png.eps): New rule. (ps-local): Add dependency on coreutils-size-map.eps. (dvi-local): New target.
2015-06-29doc: Add 'guix environment' examples.Ludovic Courtès
* doc/environment-gdb.scm: New file. * doc.am (EXTRA_DIST): Add it. * doc/guix.texi (Invoking guix environment): Clarify wording of the first example. Add a --ad-hoc example upfront. Add an example for '-e', and one for '-l'.
2015-06-21size: Add '--map-file' option.Ludovic Courtès
* guix/scripts/size.scm (profile->page-map): New procedures. (show-help, %options): Add --map-file. (guix-size): Honor it. * doc/guix.texi (Invoking guix size): Document it. * doc/images/coreutils-size-map.png: New file. * doc.am (dist_infoimage_DATA): Add it.
2015-06-18Add 'guix size'.Ludovic Courtès
* guix/scripts/size.scm: New file. * Makefile.am (MODULES): Add it. (SCM_TESTS): Add tests/size.scm. * doc.am (SUBCOMMANDS): Add 'size'. * po/guix/POTFILES.in: Add guix/scripts/size.scm. * tests/size.scm: New file. * doc/guix.texi (Packages with Multiple Outputs): Add xref to "Invoking guix size". (Invoking guix size): New node. (Invoking guix gc): Add index for "closure" and xref to the above. * doc/contributing.texi (Submitting Patches): Use @enumerate for the check list. Add item about 'guix size'.
2015-06-18Add 'guix edit'.Ludovic Courtès
* guix/scripts/edit.scm: New file. * Makefile.am (MODULES): Add it. * doc.am (SUBCOMMANDS): Add 'edit'. * doc/guix.texi (Defining Packages): Add xref to "Invoking guix edit". (Invoking guix edit): New node. * po/guix/POTFILES.in: Add it.
2015-06-16build: Don't build the guix-daemon man page when --disable-daemon.Ludovic Courtès
Fixes <http://bugs.gnu.org/20824>. Reported by Mark H Weaver <mhw@netris.org>. * doc.am (dist_man1_MANS): Conditionalize doc/guix-daemon.1 on BUILD_DAEMON.
2015-06-14doc: Move most 'HACKING' informations into the manual.Mathieu Lirzin
* HACKING (Contributing): New section. (Building from Git, The Perfect Setup, Coding Style, Submitting Patches): Move to ... * doc/guix.texi (Running Guix Before It Is Installed): Likewise. * doc/contributing.texi: ... here. New file. * doc.am (EXTRA_DIST): Use it. * README (Installation): Adapt to it. * configure.ac (DOT): Likewise.
2015-06-10build: Build man pages after the corresponding code.Ludovic Courtès
* doc.am (doc/guix.1): Remove extraneous $(top_builddir)/. (doc/guix-daemon.1): Fix dependency. (doc/guix-$(1).1): Remove extraneous $(top_builddir)/. Depend on the .go files instead of the .scm file. Add dependency on scripts/guix.
2015-06-03doc: Build guix-daemon man page.Ludovic Courtès
* doc.am (doc/guix-daemon.1): New target. (dist_man1_MANS): Add it.
2015-06-01build: Build and install manual pages.Ludovic Courtès
* configure.ac: Use 'AM_MISSING_PROG' for 'help2man'. * doc.am (subcommand-manual-target, SUBCOMMANDS, dist_man1_MANS): New variables. (doc/guix-$(1).1, doc/guix.1): New targets.
2015-05-09doc: Show both the "bare-bones" and the "desktop" configurations.Ludovic Courtès
* doc/guix.texi (System Installation): Add xref to "Using the Configuration System" instead of including one here. (Using the Configuration System): Remove first example, and include os-config-bare-bones.texi instead. Include os-config-desktop.texi as a second example. * doc.am (OS_CONFIG_EXAMPLES_TEXI): New variable. (BUILT_SOURCES, EXTRA_DIST, MAINTAINERCLEANFILES): Use it. (doc/os-config.texi): Remove. (doc/os-config-%.texi): New target.
2015-05-09doc: Rename OS config example.Ludovic Courtès
* gnu/system/os-config.tmpl: Rename to... * gnu/system/examples/bare-bones.tmpl: ... this. * Makefile.am (EXAMPLES): Adjust accordingly. * doc.am (doc/os-config.texi): Likewise. * gnu/system/install.scm (configuration-template-service)[template]: Likewise.
2014-11-17build: Add doc/emacs.texi to the distribution.Ludovic Courtès
* doc.am (EXTRA_DIST): Add doc/emacs.texi.
2014-07-24doc: Make sure out-of-source-tree builds find os-config.tmpl.Ludovic Courtès
* Makefile.am (BUILT_SOURCES): New variable. * daemon.am (BUILT_SOURCES): Use +=. * doc.am (BUILT_SOURCES, MAINTAINERCLEANFILES, EXTRA_DIST): Add doc/os-config.texi. (doc/os-config.texi): New target. * doc/guix.texi (System Installation): Include os-config.texi.
2013-10-18build: Build the bootstrap-graph.{png,eps,pdf} under $(top_srcdir).Ludovic Courtès
Fixes <http://bugs.gnu.org/15640>. Reported by Eric Bavier <ericbavier@gmail.com>. * doc.am (EXTRA_DIST): Add doc/images/bootstrap-graph.pdf to the distribution. (pdf-local, info-local, ps-local): Prepend $(top_srcdir) to the image file names.
2013-08-29build: Have `pdf' depend on the PDF image.Ludovic Courtès
* doc.am (DOT_OPTIONS): Remove `-Tpng'. (.dot.pdf): New rule. (pdf-local): Depend on the .pdf.
2013-08-29build: Use `missing' for `dot'.Ludovic Courtès
* configure.ac: Substitute `DOT'. * doc.am (.dot.png, .dot.eps): Use $(DOT).
2013-08-29build: Build docs from the top-level Makefile.Ludovic Courtès
This undoes commit 575ed8d ("doc: Create own Makefile.am in subdirectory."), and fixes a bug whereby "make pdf" or "make ps" wouldn't do anything. * doc/Makefile.am: Remove. * doc.am: New file. Use `-local' rules to build the image. * Makefile.am: Include it. * configure.ac: Use `-Woverride' to avoid undesired overridding of Automake rules.
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-12-30 12:18:05 +0000