From 14c9af0056d9ba63c9a509624cc835cb8ee2b8ad Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 11 Oct 2011 11:04:28 -0700 Subject: documentation: Makefile corrections to support web server structure The web server directory structure for the post 1.0 releases was changed. Also, the creation of a new 1.0 area in the web structure was retroactively created. this broke the five make files for publishing documents to the web. I fixed all five files so they now push to the 1.0 area only. The fix included hard-coding the 1.0 directory structure. I also set them up to be a little more generic. (From yocto-docs rev: d2cd8f1165b0cc995fc322a7d836de0902da7614) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/adt-manual/Makefile | 36 +++++++++++++++++++++++++------- documentation/bsp-guide/Makefile | 35 +++++++++++++++++++++++++------ documentation/kernel-manual/Makefile | 35 +++++++++++++++++++++++++------ documentation/poky-ref-manual/Makefile | 37 +++++++++++++++++++++++++++------ documentation/yocto-project-qs/Makefile | 33 +++++++++++++++++++++++------ 5 files changed, 145 insertions(+), 31 deletions(-) diff --git a/documentation/adt-manual/Makefile b/documentation/adt-manual/Makefile index 560913a69d..f23de5c561 100644 --- a/documentation/adt-manual/Makefile +++ b/documentation/adt-manual/Makefile @@ -1,9 +1,33 @@ +# You must call this Makefile using the following form: +# +# make +# make html +# make pdf +# make tarball +# make clean +# make publish +# +# "make" creates the HTML, PDF, and tarballs. +# "make html" creates just the HTML +# "make pdf" creates just the PDF +# "make tarball" creates the tarball +# "make clean" removes the HTML and PDF files +# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server +# + XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam chapter.autolabel 1 \ --stringparam appendix.autolabel A \ --stringparam section.autolabel 1 \ --stringparam section.label.includes.component.label 1 \ - --xinclude + --xinclude +VER = 1.0 +DOC = adt-manual +ALLPREQ = html pdf tarball +TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png +MANUALS = $(DOC).html $(DOC).pdf +FIGURES = figures +STYLESHEET = *.css ## # These URI should be rewritten by your distribution's xml catalog to @@ -27,16 +51,14 @@ html: xsltproc $(XSLTOPTS) -o adt-manual.html adt-manual-customization.xsl adt-manual.xml tarball: html - tar -cvzf adt-manual.tgz adt-manual.html adt-manual.pdf style.css figures/adt-title.png figures/yocto-project-transp.png + cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. validate: xmllint --postvalid --xinclude --noout adt-manual.xml -OUTPUTS = adt-manual.tgz adt-manual.html adt-manual.pdf -SOURCES = *.png *.xml *.css - publish: - scp -r $(OUTPUTS) $(SOURCES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-doc/adt-manual + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures clean: - rm -f $(OUTPUTS) + rm -f $(MANUALS) diff --git a/documentation/bsp-guide/Makefile b/documentation/bsp-guide/Makefile index af802b1dc4..6371a31569 100644 --- a/documentation/bsp-guide/Makefile +++ b/documentation/bsp-guide/Makefile @@ -1,9 +1,34 @@ +# You must call this Makefile using the following form: +# +# make +# make html +# make pdf +# make tarball +# make clean +# make publish +# +# "make" creates the HTML, PDF, and tarballs. +# "make html" creates just the HTML +# "make pdf" creates just the PDF +# "make tarball" creates the tarball +# "make clean" removes the HTML and PDF files +# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server +# + XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam chapter.autolabel 1 \ --stringparam section.autolabel 1 \ --stringparam section.label.includes.component.label 1 \ --xinclude +VER = 1.0 +DOC = bsp-guide +ALLPREQ = html pdf tarball +TARFILES = bsp-guide.html bsp-guide.pdf style.css figures/bsp-title.png +MANUALS = $(DOC).html $(DOC).pdf +FIGURES = figures +STYLESHEET = *.css + ## # These URI should be rewritten by your distribution's xml catalog to # match your localy installed XSL stylesheets. @@ -20,16 +45,14 @@ html: xsltproc $(XSLTOPTS) -o bsp-guide.html bsp-guide-customization.xsl bsp-guide.xml tarball: html - tar -cvzf bsp-guide.tgz style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png + cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. validate: xmllint --postvalid --xinclude --noout bsp-guide.xml -OUTPUTS = bsp-guide.pdf bsp-guide.html -SOURCES = *.png *.xml *.css *.svg - publish: - scp -r $(OUTPUTS) $(SOURCES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-doc/bsp-guide + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures clean: - rm -f $(OUTPUTS) + rm -f $(MANUALS) diff --git a/documentation/kernel-manual/Makefile b/documentation/kernel-manual/Makefile index 6c855cd588..2d9cc98c18 100644 --- a/documentation/kernel-manual/Makefile +++ b/documentation/kernel-manual/Makefile @@ -1,3 +1,20 @@ +# You must call this Makefile using the following form: +# +# make +# make html +# make pdf +# make tarball +# make clean +# make publish +# +# "make" creates the HTML, PDF, and tarballs. +# "make html" creates just the HTML +# "make pdf" creates just the PDF +# "make tarball" creates the tarball +# "make clean" removes the HTML and PDF files +# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server +# + XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam chapter.autolabel 1 \ --stringparam appendix.autolabel A \ @@ -5,6 +22,14 @@ XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam section.label.includes.component.label 1 \ --xinclude +VER = 1.0 +DOC = kernel-manual +ALLPREQ = html pdf tarball +TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png +MANUALS = $(DOC).html $(DOC).pdf +FIGURES = figures +STYLESHEET = *.css + ## # These URI should be rewritten by your distribution's xml catalog to # match your localy installed XSL stylesheets. @@ -27,16 +52,14 @@ html: xsltproc $(XSLTOPTS) -o kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml tarball: html - tar -cvzf kernel-manual.tgz kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-big-picture.png figures/kernel-architecture-overview.png + cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. validate: xmllint --postvalid --xinclude --noout kernel-manual.xml -OUTPUTS = kernel-manual.tgz kernel-manual.html kernel-manual.pdf -SOURCES = *.png *.xml *.css - publish: - scp -r $(OUTPUTS) $(SOURCES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-doc/kernel-manual + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures clean: - rm -f $(OUTPUTS) + rm -f $(MANUALS) diff --git a/documentation/poky-ref-manual/Makefile b/documentation/poky-ref-manual/Makefile index 82ac880a74..f686304f3d 100644 --- a/documentation/poky-ref-manual/Makefile +++ b/documentation/poky-ref-manual/Makefile @@ -1,3 +1,20 @@ +# You must call this Makefile using the following form: +# +# make +# make html +# make pdf +# make tarball +# make clean +# make publish +# +# "make" creates the HTML, PDF, and tarballs. +# "make html" creates just the HTML +# "make pdf" creates just the PDF +# "make tarball" creates the tarball +# "make clean" removes the HTML and PDF files +# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server +# + XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam chapter.autolabel 1 \ --stringparam appendix.autolabel A \ @@ -5,6 +22,15 @@ XSLTOPTS = --stringparam html.stylesheet style.css \ --stringparam section.label.includes.component.label 1 \ --xinclude +VER = 1.0 +DOC = poky-ref-manual +ALLPREQ = html pdf tarball +TARFILES = poky-ref-manual.html poky-ref-manual.pdf style.css figures/yocto-project-transp.png figures/poky-ref-manual.png screenshots/ss-sato.png +MANUALS = $(DOC).html $(DOC).pdf +FIGURES = figures +SCREENSHOTS = screenshots +STYLESHEET = *.css + ## # These URI should be rewritten by your distribution's xml catalog to # match your localy installed XSL stylesheets. @@ -21,16 +47,15 @@ html: xsltproc $(XSLTOPTS) -o poky-ref-manual.html poky-ref-manual-customization.xsl poky-ref-manual.xml tarball: html - tar -cvzf poky-ref-manual.tgz poky-ref-manual.html style.css figures/yocto-project-transp.png figures/poky-ref-manual.png screenshots/ss-sato.png + cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd .. validate: xmllint --postvalid --xinclude --noout poky-ref-manual.xml -OUTPUTS = poky-ref-manual.tgz poky-ref-manual.html poky-ref-manual.pdf -SOURCES = *.png *.xml *.css *.svg - publish: - scp -r $(OUTPUTS) $(SOURCES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-doc/poky-ref-manual + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures + scp -r $(SCREENSHOTS) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/screenshots clean: - rm -f $(OUTPUTS) + rm -f $(MANUALS) diff --git a/documentation/yocto-project-qs/Makefile b/documentation/yocto-project-qs/Makefile index 41c35e11a9..c58a8e914f 100644 --- a/documentation/yocto-project-qs/Makefile +++ b/documentation/yocto-project-qs/Makefile @@ -1,6 +1,29 @@ +# You must call this Makefile using the following form: +# +# make +# make html +# make tarball +# make clean +# make publish +# +# "make" creates the HTML and tarball. +# "make html" creates just the HTML +# "make tarball" creates the tarball +# "make clean" removes the HTML file +# "make publish" pushes the HTML, figures, and stylesheet to the web server +# + XSLTOPTS = --stringparam html.stylesheet style.css \ --xinclude +VER = 1.0 +DOC = yocto-quick-start +ALLPREQ = html pdf tarball +TARFILES = yocto-project-qs.html style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png +MANUALS = yocto-project-qs.html +FIGURES = figures +STYLESHEET = *.css + XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl @@ -17,16 +40,14 @@ html: xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml tarball: html - tar -cvzf yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png + cd $(DOC); tar -cvzf yocto-project-qs.tgz $(TARFILES); cd .. validate: xmllint --postvalid --xinclude --noout yocto-project-qs.xml -OUTPUTS = yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf -SOURCES = *.png *.xml *.css - publish: - scp -r $(OUTPUTS) $(SOURCES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-doc/yocto-quick-start + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC) + scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures clean: - rm -f $(OUTPUTS) + rm -f $(MANUALS) -- cgit v1.2.3-54-g00ecf