improve Makefile: add phony target 'index'

You can now simply use "make index" to generate and viw all docs.

diff --git a/Makefile b/Makefile
index 9c278c4bf99aaae65cce37936427c7508930f52f..be97bf0676860ac7ec8de65b07306f5c39d55a31 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -165,12 +165,15 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
        asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
        test -n "$${NOVIEW}" || $(BROWSER) $@ &
 
+.PHONY: index
+index: index.html
+       test -n "$${NOVIEW}" || $(BROWSER) index.html &
+
 index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
        $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
        $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
        $(MAKE) NOVIEW=1 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
        asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
-       test -n "$${NOVIEW}" || $(BROWSER) index.html &
 
 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
        asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
@@ -217,10 +220,7 @@ DOC_DEB_FILES=                                                             \
        pve-admin-guide.epub    \
        index.html
 
-${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
-       $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
-       $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
-       asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
+${DOC_DEB}: index.html
        rm -rf build
        mkdir build
        rsync -a doc-debian/ build/debian

diff --git a/README.adoc b/README.adoc
index 7e7431ad91fd73fdad17e0c7eac13e76edb9f13b..173a54490c5578f1d217ec2539df8992884020ab 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -19,11 +19,21 @@ To simplify the documentation task, we keep all Documentation within
 this repository. It is possible to generate the docs (without installing
 any additional Proxmox packages) with:
 
- make index.html
+ make index
 
-We also generate an additional development package called
-'pve-doc-generator', which is used by other Proxmox VE package to
-generate manual pages at package build time.
+
+Debian Packages
+---------------
+
+We generate a development package called 'pve-doc-generator', which is
+used by other Proxmox VE package to generate manual pages at package
+build time.
+
+Another package called 'pve-docs' is used to publish generated
+'.html' and '.pdf' files on our web servers. You can generate
+those debian packages using:
+
+ make deb
 
 
 Common Macro definition in link:attributes.txt[]

diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc
index 29b79edb3851fc2030b124cd73bf96aa95ad1c8e..e4be8d73e207b41943cb6610ca01a1ca6520a497 100644 (file)
--- a/pve-admin-guide.adoc
+++ b/pve-admin-guide.adoc
@@ -58,6 +58,7 @@ include::pveceph.adoc[]
 
 include::pvesubscription.adoc[]
 
+
 :leveloffset: 1
 
 include::pve-faq.adoc[]