summary refs log tree commit diff
path: root/doc.am
AgeCommit message (Collapse)Author
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.