me
/
guix
Archived
1
0
Fork 0
Code
This repository has been archived on 2024-08-07. You can view files and clone it, but cannot push or open issues/pull-requests.
guix/doc.am

155 lines
4.8 KiB
Plaintext
Raw Normal View History

doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
# GNU Guix --- Functional package management for GNU
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
build: Fix out-of-tree building of documentation. * doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2016-01-10 09:14:43 +00:00
# Copyright © 2012, 2013, 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
# Copyright © 2013 Andreas Enge <andreas@enge.fr>
build: Fix out-of-tree building of documentation. * doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2016-01-10 09:14:43 +00:00
# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
# Copyright © 2016 Mathieu Lirzin <mthl@gnu.org>
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
#
# This file is part of GNU Guix.
#
# GNU Guix is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GNU Guix is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
build: Build docs from the top-level Makefile. 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.
2013-08-29 19:20:51 +00:00
info_TEXINFOS = doc/guix.texi
Add 'guix graph'. * 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-26 22:36:41 +00:00
DOT_FILES = \
doc/images/bootstrap-graph.dot \
doc: Show bootstrapping at the package level. * 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-12 14:52:56 +00:00
doc/images/bootstrap-packages.dot \
Add 'guix graph'. * 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-26 22:36:41 +00:00
doc/images/coreutils-graph.dot \
services: Introduce extensible services. 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-09-17 21:44:26 +00:00
doc/images/coreutils-bag-graph.dot \
guix system: Add 'dmd-graph' command. * 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-14 17:17:12 +00:00
doc/images/service-graph.dot \
guix system: Rename 'dmd-graph' to 'shepherd-graph'. * 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-27 20:06:07 +00:00
doc/images/shepherd-graph.dot
Add 'guix graph'. * 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-26 22:36:41 +00:00
DOT_VECTOR_GRAPHICS = \
$(DOT_FILES:%.dot=%.eps) \
$(DOT_FILES:%.dot=%.pdf)
build: Build docs from the top-level Makefile. 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.
2013-08-29 19:20:51 +00:00
EXTRA_DIST += \
doc: Move most 'HACKING' informations into the manual. * 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-10 11:39:54 +00:00
doc/contributing.texi \
build: Add doc/emacs.texi to the distribution. * doc.am (EXTRA_DIST): Add doc/emacs.texi.
2014-11-17 17:02:05 +00:00
doc/emacs.texi \
build: Build docs from the top-level Makefile. 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.
2013-08-29 19:20:51 +00:00
doc/fdl-1.3.texi \
Add 'guix graph'. * 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-26 22:36:41 +00:00
$(DOT_FILES) \
$(DOT_VECTOR_GRAPHICS) \
build: Build coreutils-size-map.eps for the sake of the PS and DVI outputs. * 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-07-19 19:55:21 +00:00
doc/images/coreutils-size-map.eps \
scripts: package: Add --install-from-file option. * 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-08-09 15:35:51 +00:00
doc/environment-gdb.scm \
doc/package-hello.scm
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
doc: Show both the "bare-bones" and the "desktop" configurations. * 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-09 21:51:46 +00:00
OS_CONFIG_EXAMPLES_TEXI = \
doc/os-config-bare-bones.texi \
doc/os-config-desktop.texi
doc: Make sure out-of-source-tree builds find os-config.tmpl. * 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.
2014-07-24 21:38:39 +00:00
# Bundle this file so that makeinfo finds it in out-of-source-tree builds.
doc: Show both the "bare-bones" and the "desktop" configurations. * 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-09 21:51:46 +00:00
BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI)
EXTRA_DIST += $(OS_CONFIG_EXAMPLES_TEXI)
MAINTAINERCLEANFILES = $(OS_CONFIG_EXAMPLES_TEXI)
doc: Make sure out-of-source-tree builds find os-config.tmpl. * 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.
2014-07-24 21:38:39 +00:00
doc: Show both the "bare-bones" and the "desktop" configurations. * 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-09 21:51:46 +00:00
doc/os-config-%.texi: gnu/system/examples/%.tmpl
build: Use 'GEN' and 'at' silent rules. * 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-24 18:04:53 +00:00
$(AM_V_GEN)$(MKDIR_P) "`dirname $@`"; \
doc: Make sure out-of-source-tree builds find os-config.tmpl. * 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.
2014-07-24 21:38:39 +00:00
cp "$<" "$@"
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
infoimagedir = $(infodir)/images
size: Add '--map-file' option. * 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-21 21:25:19 +00:00
dist_infoimage_DATA = \
Add 'guix graph'. * 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-26 22:36:41 +00:00
$(DOT_FILES:%.dot=%.png) \
size: Add '--map-file' option. * 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-21 21:25:19 +00:00
doc/images/coreutils-size-map.png
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
# Try hard to obtain an image size and aspect that's reasonable for inclusion
# in an Info or PDF document.
build: Have `pdf' depend on the PDF image. * doc.am (DOT_OPTIONS): Remove `-Tpng'. (.dot.pdf): New rule. (pdf-local): Depend on the .pdf.
2013-08-29 19:57:09 +00:00
DOT_OPTIONS = \
-Gratio=.9 -Gnodesep=.005 -Granksep=.00005 \
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
-Nfontsize=9 -Nheight=.1 -Nwidth=.1
.dot.png:
build: Add 'DOT' silent rule. * 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-24 17:55:38 +00:00
$(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
build: Fix out-of-tree building of documentation. * doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2016-01-10 09:14:43 +00:00
mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
build: Have `pdf' depend on the PDF image. * doc.am (DOT_OPTIONS): Remove `-Tpng'. (.dot.pdf): New rule. (pdf-local): Depend on the .pdf.
2013-08-29 19:57:09 +00:00
.dot.pdf:
build: Add 'DOT' silent rule. * 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-24 17:55:38 +00:00
$(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
build: Fix out-of-tree building of documentation. * doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2016-01-10 09:14:43 +00:00
mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
build: Have `pdf' depend on the PDF image. * doc.am (DOT_OPTIONS): Remove `-Tpng'. (.dot.pdf): New rule. (pdf-local): Depend on the .pdf.
2013-08-29 19:57:09 +00:00
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
.dot.eps:
build: Add 'DOT' silent rule. * 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-24 17:55:38 +00:00
$(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
build: Fix out-of-tree building of documentation. * doc.am (.dot.png, .dot.pdf, .dot.eps): Put the generated files into $(srcdir).
2016-01-10 09:14:43 +00:00
mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
doc: Create own Makefile.am in subdirectory. * doc/Makefile.am: New file. * Makefile.am: Reference subdirectory doc.
2013-08-28 19:44:14 +00:00
build: Build coreutils-size-map.eps for the sake of the PS and DVI outputs. * 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-07-19 19:55:21 +00:00
.png.eps:
build: Use 'GEN' and 'at' silent rules. * 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-24 18:04:53 +00:00
$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
build: Build coreutils-size-map.eps for the sake of the PS and DVI outputs. * 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-07-19 19:55:21 +00:00
mv "$@-tmp.eps" "$@"
build: Build docs from the top-level Makefile. 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.
2013-08-29 19:20:51 +00:00
# We cannot add new dependencies to `doc/guix.pdf' & co. (info "(automake)
# Extending"). Using the `-local' rules is imperfect, because they may be
# triggered after the main rule. Oh, well.
Add 'guix graph'. * 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-26 22:36:41 +00:00
pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps) \
build: Build coreutils-size-map.eps for the sake of the PS and DVI outputs. * 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-07-19 19:55:21 +00:00
$(top_srcdir)/doc/images/coreutils-size-map.eps
dvi-local: ps-local
build: Build and install manual pages. * 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-06-01 20:37:54 +00:00
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
## ----------- ##
## Man pages. ##
## ----------- ##
sub_commands_mans = \
doc/guix-archive.1 \
doc/guix-build.1 \
doc/guix-challenge.1 \
doc/guix-download.1 \
doc/guix-edit.1 \
doc/guix-environment.1 \
doc/guix-gc.1 \
doc/guix-hash.1 \
doc/guix-import.1 \
doc/guix-lint.1 \
doc/guix-package.1 \
doc/guix-publish.1 \
doc/guix-pull.1 \
doc/guix-refresh.1 \
doc/guix-size.1 \
doc/guix-system.1
build: Build and install manual pages. * 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-06-01 20:37:54 +00:00
dist_man1_MANS = \
doc/guix.1 \
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
$(sub_commands_mans)
# Man pages are generated using GNU help2man.
build: Use the right section and source for man pages. * doc.am (HELP2MANFLAGS): New variable. (gen_man): Use it.
2016-01-31 16:35:56 +00:00
gen_man = \
LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \
$(HELP2MANFLAGS)
HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
# Note: Do not depend on 'scripts/guix' since that would trigger a rebuild
# even for people building from a tarball.
doc/guix.1: $(sub_commands_mans)
-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
# Note: The dependency on $(GOBJECTS) is meant to force these docs to be made
# only after all Guile modules have been compiled. The 'case' ensures the man
# pages are only generated if the corresponding script source has been
# changed.
doc/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
-@case '$?' in \
*$<*) $(AM_V_P) && set -x || echo " HELP2MAN $@"; \
$(gen_man) --output="$@" "guix $*";; \
*) : ;; \
esac
build: Don't build the guix-daemon man page when --disable-daemon. 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-16 08:04:35 +00:00
if BUILD_DAEMON
build: Generate man pages after compiling Guile objects. 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-28 02:31:04 +00:00
dist_man1_MANS += doc/guix-daemon.1
# Note: Do not depend on 'guix-daemon' since that would trigger a rebuild even
# for people building from a tarball.
doc/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
build: Don't build the guix-daemon man page when --disable-daemon. 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-16 08:04:35 +00:00
endif