[PATCH 04/11] emacs: build docstring (rsti) files

David Bremner david at tethera.net
Wed Jun 13 17:32:38 PDT 2018


These are intended to included in the sphinx manual for notmuch-emacs.
The stamp file makes it easier to depend on the docstrings from other
parts of the build
---
 emacs/.gitignore     |  1 +
 emacs/Makefile.local | 11 +++++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/emacs/.gitignore b/emacs/.gitignore
index fbf8dde6..b9873b0a 100644
--- a/emacs/.gitignore
+++ b/emacs/.gitignore
@@ -1,4 +1,5 @@
 /.eldeps*
 /*.elc
+/*.rsti
 /notmuch-version.el
 /notmuch-pkg.el
diff --git a/emacs/Makefile.local b/emacs/Makefile.local
index 1b3ef584..38d1f5c5 100644
--- a/emacs/Makefile.local
+++ b/emacs/Makefile.local
@@ -45,6 +45,10 @@ emacs_images := \
 	$(srcdir)/$(dir)/notmuch-logo.png
 
 emacs_bytecode = $(emacs_sources:.el=.elc)
+emacs_docstrings = $(emacs_sources:.el=.rsti)
+
+docstring.stamp: ${emacs_docstrings}
+	touch $@
 
 # Because of defmacro's and defsubst's, we have to account for load
 # dependencies between Elisp files when byte compiling.  Otherwise,
@@ -76,6 +80,8 @@ CLEAN+=$(dir)/.eldeps $(dir)/.eldeps.tmp $(dir)/.eldeps.x
 ifeq ($(HAVE_EMACS),1)
 %.elc: %.el $(global_deps)
 	$(call quiet,EMACS) --directory emacs -batch -f batch-byte-compile $<
+%.rsti: %.el
+	$(call quiet,EMACS) -batch -L emacs -l rstdoc -f rstdoc-batch-extract $< $@
 endif
 
 elpa: $(ELPA_FILE)
@@ -93,7 +99,7 @@ endif
 
 ifeq ($(WITH_EMACS),1)
 ifeq ($(HAVE_EMACS),1)
-all: $(emacs_bytecode)
+all: $(emacs_bytecode) $(emacs_docstrings)
 install-emacs: $(emacs_bytecode)
 endif
 
@@ -117,4 +123,5 @@ ifeq ($(WITH_DESKTOP),1)
 	-update-desktop-database "$(DESTDIR)$(desktop_dir)"
 endif
 
-CLEAN := $(CLEAN) $(emacs_bytecode) $(dir)/notmuch-version.el $(dir)/notmuch-pkg.el
+CLEAN := $(CLEAN) $(emacs_bytecode) $(dir)/notmuch-version.el $(dir)/notmuch-pkg.el \
+	$(emacs_docstrings) docstring.stamp
-- 
2.17.1



More information about the notmuch mailing list