docs/build: Move two rules for consistency, and comment sections

No functional change.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
CC: Ian Campbell <Ian.Campbell@citrix.com>
CC: Ian Jackson <Ian.Jackson@eu.citrix.com>
CC: Wei Liu <wei.liu2@citrix.com>
Acked-by: Ian Campbell <Ian.Campbell@citrix.com>

diff --git a/docs/Makefile b/docs/Makefile
index 6f795846aa9ae388741eb34330b7cd2803e4e0ac..0b458f16517399875718ac86ea5e913df50bbd07 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -16,7 +16,7 @@ MARKDOWNSRC-y := $(sort $(wildcard misc/*.markdown))
 
 TXTSRC-y := $(sort $(wildcard misc/*.txt))
 
-
+# Documentation targets
 DOC_MAN1 := $(patsubst man/%.pod.1,man1/%.1,$(MAN1SRC-y))
 DOC_MAN5 := $(patsubst man/%.pod.5,man5/%.5,$(MAN5SRC-y))
 DOC_HTML := $(patsubst %.markdown,html/%.html,$(MARKDOWNSRC-y)) \
@@ -30,6 +30,7 @@ DOC_TXT  := $(patsubst %.txt,txt/%.txt,$(TXTSRC-y)) \
             $(patsubst man/%.pod.5,txt/man/%.5.txt,$(MAN5SRC-y))
 DOC_PDF  := $(patsubst %.markdown,pdf/%.pdf,$(MARKDOWNSRC-y))
 
+# Top level build targets
 .PHONY: all
 all: build
 
@@ -71,14 +72,6 @@ else
        @echo "pandoc not installed; skipping pdfs."
 endif
 
-man1/%.1: man/%.pod.1 Makefile
-       $(INSTALL_DIR) $(@D)
-       $(POD2MAN) --release=$(VERSION) --name=$* -s 1 -c "Xen" $< $@
-
-man5/%.5: man/%.pod.5 Makefile
-       $(INSTALL_DIR) $(@D)
-       $(POD2MAN) --release=$(VERSION) --name=$* -s 5 -c "Xen" $< $@
-
 .PHONY: clean
 clean:
        $(MAKE) -C figs clean
@@ -93,6 +86,7 @@ distclean: clean
        rm -rf $(XEN_ROOT)/config/Docs.mk config.log config.status config.cache \
                autom4te.cache
 
+# Top level install targets
 .PHONY: install-man-pages
 install-man-pages: man-pages
        $(INSTALL_DIR) $(DESTDIR)$(MANDIR)
@@ -107,6 +101,15 @@ install-html: html txt figs
 .PHONY: install
 install: install-man-pages install-html
 
+# Individual file build targets
+man1/%.1: man/%.pod.1 Makefile
+       $(INSTALL_DIR) $(@D)
+       $(POD2MAN) --release=$(VERSION) --name=$* -s 1 -c "Xen" $< $@
+
+man5/%.5: man/%.pod.5 Makefile
+       $(INSTALL_DIR) $(@D)
+       $(POD2MAN) --release=$(VERSION) --name=$* -s 5 -c "Xen" $< $@
+
 html/index.html: $(DOC_HTML) $(CURDIR)/gen-html-index INDEX
        $(PERL) -w -- $(CURDIR)/gen-html-index -i INDEX html $(DOC_HTML)