From: Mathieu Lirzin <mthl@gnu.org>
To: guix-devel@gnu.org
Subject: [PATCH 4/4] build: Rewrite comments for man pages.
Date: Sat, 19 Mar 2016 17:18:06 +0100 [thread overview]
Message-ID: <1458404286-10448-5-git-send-email-mthl@gnu.org> (raw)
In-Reply-To: <1458404286-10448-1-git-send-email-mthl@gnu.org>
* doc.am <Man pages>: Rewrite comments to describe the build process and
the meaning of the noticeable idiosyncrasies in a more general way.
---
doc.am | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/doc.am b/doc.am
index 956ac1f..8356ffa 100644
--- a/doc.am
+++ b/doc.am
@@ -98,6 +98,12 @@ dvi-local: ps-local
## Man pages. ##
## ----------- ##
+# The man pages are generated using GNU Help2man. In makefiles rules they
+# depend not on the binary, but on the source files. This usage allows a
+# manual page to be generated by the maintainer and included in the
+# distribution without requiring the end-user to have 'help2man' installed.
+# They are built in $(srcdir) like info manuals.
+
sub_commands_mans = \
$(srcdir)/doc/guix-archive.1 \
$(srcdir)/doc/guix-build.1 \
@@ -120,22 +126,19 @@ dist_man1_MANS = \
$(srcdir)/doc/guix.1 \
$(sub_commands_mans)
-# Man pages are generated using GNU help2man.
gen_man = \
LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \
$(HELP2MANFLAGS)
HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
-# Note: Do not depend on 'scripts/guix' since that would trigger a rebuild
-# even for people building from a tarball.
$(srcdir)/doc/guix.1: scripts/guix.in $(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.
+# The 'case' ensures the man pages are only generated if the corresponding
+# source script (the first prerequisite) has been changed. The $(GOBJECTS)
+# prerequisite is solely meant to force these docs to be made only after all
+# Guile modules have been compiled.
$(srcdir)/doc/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
-@case '$?' in \
*$<*) $(AM_V_P) && set -x || echo " HELP2MAN $@"; \
@@ -147,8 +150,6 @@ if BUILD_DAEMON
dist_man1_MANS += $(srcdir)/doc/guix-daemon.1
-# Note: Do not depend on 'guix-daemon' since that would trigger a rebuild even
-# for people building from a tarball.
$(srcdir)/doc/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
--
2.7.0
next prev parent reply other threads:[~2016-03-19 16:18 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-03-19 16:18 [PATCH 0/4] Build man pages in $(srcdir) Mathieu Lirzin
2016-03-19 16:18 ` [PATCH 1/4] Revert "build: Do not remake doc/guix.1." Mathieu Lirzin
2016-03-19 21:29 ` Ludovic Courtès
2016-03-19 16:18 ` [PATCH 2/4] build: Make 'guix' man page depend on scripts/guix.in Mathieu Lirzin
2016-03-19 21:31 ` Ludovic Courtès
2016-03-19 16:18 ` [PATCH 3/4] build: Build man pages in $(srcdir) Mathieu Lirzin
2016-03-19 21:31 ` Ludovic Courtès
2016-03-19 16:18 ` Mathieu Lirzin [this message]
2016-03-19 21:32 ` [PATCH 4/4] build: Rewrite comments for man pages Ludovic Courtès
2016-03-19 21:28 ` [PATCH 0/4] Build man pages in $(srcdir) Ludovic Courtès
2016-03-19 21:33 ` Ludovic Courtès
2016-03-19 22:50 ` Mathieu Lirzin
2016-03-20 21:09 ` Ludovic Courtès
2016-03-20 23:03 ` Mathieu Lirzin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1458404286-10448-5-git-send-email-mthl@gnu.org \
--to=mthl@gnu.org \
--cc=guix-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).