diff mbox series

[v1,2/7] doc: fix documentation building

Message ID 1498651220-13948-3-git-send-email-odpbot@yandex.ru
State Superseded
Headers show
Series [v1,1/7] doc: add IMAGES_DIR instead of specifying full path to images | expand

Commit Message

Github ODP bot June 28, 2017, noon UTC 
From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>


Set VPATH to just $(srcdir) so that make can locate adoc files itself.
Drop long paths starting from $(top_srcdir), which are unnecessary now.
Properly declare SUFFIXES used in documentation building (so that
automake can pass that to make to enable proper rules substitution).

Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>

---
/** Email created from pull request 61 (lumag:docs-fix)
 ** https://github.com/Linaro/odp/pull/61
 ** Patch: https://github.com/Linaro/odp/pull/61.patch
 ** Base sha: c6a309f00f882fabe70fa535ebe8b765f6e9bd11
 ** Merge commit sha: ab4e27ee16b8da05ab2d4d61c58f41235cfddbcf
 **/
 doc/Makefile.am                    |  8 ++++----
 doc/Makefile.inc                   |  4 +++-
 doc/implementers-guide/Makefile.am |  2 +-
 doc/process-guide/Makefile.am      | 12 ++++++------
 doc/users-guide/Makefile.am        | 16 +++++++---------
 5 files changed, 21 insertions(+), 21 deletions(-)
diff mbox series

Patch

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 59d6a6c6..c6124f46 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -9,7 +9,7 @@  SUBDIRS += implementers-guide users-guide process-guide
 endif
 
 EXTRA_DIST = \
-	   $(top_srcdir)/doc/doxygenlayout.xml \
-	   $(top_srcdir)/doc/odpdoxygen.css \
-	   $(top_srcdir)/doc/glossary.adoc \
-	   $(top_srcdir)/doc/Doxyfile_common
+	   doxygenlayout.xml \
+	   odpdoxygen.css \
+	   glossary.adoc \
+	   Doxyfile_common
diff --git a/doc/Makefile.inc b/doc/Makefile.inc
index 4a1acf98..23703127 100644
--- a/doc/Makefile.inc
+++ b/doc/Makefile.inc
@@ -1,6 +1,8 @@ 
 IMAGES_DIR = $(top_srcdir)/doc/images
 
-VPATH=$(top_builddir)/doc/images
+VPATH = $(srcdir)
+
+SUFFIXES = .svg .msc .gv .html .adoc
 
 .msc.svg:
 	mscgen -T svg -i $^ -o $@
diff --git a/doc/implementers-guide/Makefile.am b/doc/implementers-guide/Makefile.am
index 4bdb970e..2d48d840 100644
--- a/doc/implementers-guide/Makefile.am
+++ b/doc/implementers-guide/Makefile.am
@@ -1,6 +1,6 @@ 
 include ../Makefile.inc
 
-SRC    = $(top_srcdir)/doc/implementers-guide/implementers-guide.adoc
+SRC    = implementers-guide.adoc
 TARGET = implementers-guide.html
 
 EXTRA_DIST = $(SRC)
diff --git a/doc/process-guide/Makefile.am b/doc/process-guide/Makefile.am
index da8bb0ae..6db7c867 100644
--- a/doc/process-guide/Makefile.am
+++ b/doc/process-guide/Makefile.am
@@ -7,9 +7,9 @@  IMAGES =   $(IMAGES_DIR)/aboutODP1.svg \
 	   $(IMAGES_DIR)/aboutODP5.svg \
 	   $(IMAGES_DIR)/overview.svg
 
-EXTRA_DIST = $(top_srcdir)/doc/process-guide/bylaws-guide.adoc \
-	     $(top_srcdir)/doc/process-guide/release-guide.adoc \
-	     $(top_srcdir)/doc/process-guide/faq.adoc \
+EXTRA_DIST = bylaws-guide.adoc \
+	     release-guide.adoc \
+	     faq.adoc \
 	     $(top_srcdir)/CONTRIBUTING \
 	     $(IMAGES)
 
@@ -26,13 +26,13 @@  clean-local:
 	rm -f $(builddir)/CONTRIBUTING.html
 	rm -f $(builddir)/CHANGELOG.html
 
-release-guide.html: $(top_srcdir)/doc/process-guide/release-guide.adoc \
+release-guide.html: release-guide.adoc \
 		    $(IMAGES_DIR)/simple_release_git.svg \
 		    $(IMAGES_DIR)/release_git.svg
 
-bylaws-guide.html:  $(top_srcdir)/doc/process-guide/bylaws-guide.adoc
+bylaws-guide.html:  bylaws-guide.adoc
 
-faq.html:  $(top_srcdir)/doc/process-guide/faq.adoc \
+faq.html:  faq.adoc \
 	   $(IMAGES)
 
 #special case is not postfixed .adoc
diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am
index ae718268..871e2eab 100644
--- a/doc/users-guide/Makefile.am
+++ b/doc/users-guide/Makefile.am
@@ -1,12 +1,12 @@ 
 include ../Makefile.inc
 
-SRC    = $(top_srcdir)/doc/users-guide/users-guide.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-cls.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-crypto.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-packet.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-pktio.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-timer.adoc \
-	 $(top_srcdir)/doc/users-guide/users-guide-tm.adoc
+SRC    = users-guide.adoc \
+	 users-guide-cls.adoc \
+	 users-guide-crypto.adoc \
+	 users-guide-packet.adoc \
+	 users-guide-pktio.adoc \
+	 users-guide-timer.adoc \
+	 users-guide-tm.adoc
 TARGET = users-guide.html
 IMAGES = $(IMAGES_DIR)/overview.svg \
 	 $(IMAGES_DIR)/atomic_queue.svg \
@@ -50,5 +50,3 @@  $(TARGET): $(SRC) $(IMAGES)
 
 clean-local:
 	rm -f $(builddir)/$(TARGET)
-
-$(SRC): $(IMAGES)