summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBeth Flanagan <elizabeth.flanagan@intel.com>2011-06-02 10:18:35 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-12-20 22:35:16 +0000
commita02537187fcf131f1b97ec38d6f88a1ae82649fa (patch)
treea2020aa4a09031610aea55522494d4aa98bbda9d
parent78d092fe7a6b12e737ddc7c9564a72ad85a8a3c9 (diff)
downloadpoky-a02537187fcf131f1b97ec38d6f88a1ae82649fa.tar.gz
documentation: [YOCTO #1025] build system for docs
These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: b5cb0801691dbedfa9d3733a6b62450c8a674fa0) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/Makefile84
-rw-r--r--documentation/adt-manual/Makefile64
-rw-r--r--documentation/bsp-guide/Makefile58
-rw-r--r--documentation/kernel-manual/Makefile65
-rw-r--r--documentation/kernel-manual/kernel-manual-customization.xsl (renamed from documentation/kernel-manual/yocto-project-kernel-manual-customization.xsl)0
-rw-r--r--documentation/poky-ref-manual/Makefile61
-rw-r--r--documentation/yocto-project-qs/Makefile53
7 files changed, 84 insertions, 301 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
new file mode 100644
index 0000000000..a22abb23c2
--- /dev/null
+++ b/documentation/Makefile
@@ -0,0 +1,84 @@
1DISTROVERSION=1.1
2ifeq ($(DOC),bsp-guide)
3XSLTOPTS = --stringparam html.stylesheet style.css \
4 --stringparam chapter.autolabel 1 \
5 --stringparam section.autolabel 1 \
6 --stringparam section.label.includes.component.label 1 \
7 --xinclude
8ALLPREQ = html pdf tarball
9TARFILES = style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
10endif
11
12ifeq ($(DOC),yocto-project-qs)
13XSLTOPTS = --stringparam html.stylesheet style.css \
14 --xinclude
15ALLPREQ = html tarball
16TARFILES = 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
17endif
18
19ifeq ($(DOC),poky-ref-manual)
20XSLTOPTS = --stringparam html.stylesheet style.css \
21 --stringparam chapter.autolabel 1 \
22 --stringparam appendix.autolabel A \
23 --stringparam section.autolabel 1 \
24 --stringparam section.label.includes.component.label 1 \
25 --xinclude
26ALLPREQ = html pdf tarball
27TARFILES = poky-ref-manual.html style.css figures/poky-title.png figures/ss-sato.png
28endif
29
30
31ifeq ($(DOC),adt-manual)
32XSLTOPTS = --stringparam html.stylesheet style.css \
33 --stringparam chapter.autolabel 1 \
34 --stringparam appendix.autolabel A \
35 --stringparam section.autolabel 1 \
36 --stringparam section.label.includes.component.label 1 \
37 --xinclude
38ALLPREQ = html pdf tarball
39TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png
40endif
41
42ifeq ($(DOC),kernel-manual)
43XSLTOPTS = --stringparam html.stylesheet style.css \
44 --stringparam chapter.autolabel 1 \
45 --stringparam appendix.autolabel A \
46 --stringparam section.autolabel 1 \
47 --stringparam section.label.includes.component.label 1 \
48 --xinclude
49ALLPREQ = html pdf tarball
50TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
51endif
52
53
54##
55# These URI should be rewritten by your distribution's xml catalog to
56# match your localy installed XSL stylesheets.
57XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
58XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
59
60all: $(ALLPREQ)
61
62pdf:
63 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
64
65html:
66# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
67 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
68
69tarball: html
70 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
71
72validate:
73 cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
74
75MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
76FIGURES = $(DOC)/figures/*.png
77STYLESHEET = *.css
78
79publish:
80 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC)
81 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(DISTROVERSION)/$(DOC)/figures
82
83clean:
84 rm -f $(MANUALS)
diff --git a/documentation/adt-manual/Makefile b/documentation/adt-manual/Makefile
deleted file mode 100644
index f23de5c561..0000000000
--- a/documentation/adt-manual/Makefile
+++ /dev/null
@@ -1,64 +0,0 @@
1# You must call this Makefile using the following form:
2#
3# make
4# make html
5# make pdf
6# make tarball
7# make clean
8# make publish
9#
10# "make" creates the HTML, PDF, and tarballs.
11# "make html" creates just the HTML
12# "make pdf" creates just the PDF
13# "make tarball" creates the tarball
14# "make clean" removes the HTML and PDF files
15# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
16#
17
18XSLTOPTS = --stringparam html.stylesheet style.css \
19 --stringparam chapter.autolabel 1 \
20 --stringparam appendix.autolabel A \
21 --stringparam section.autolabel 1 \
22 --stringparam section.label.includes.component.label 1 \
23 --xinclude
24VER = 1.0
25DOC = adt-manual
26ALLPREQ = html pdf tarball
27TARFILES = adt-manual.html adt-manual.pdf style.css figures/adt-title.png
28MANUALS = $(DOC).html $(DOC).pdf
29FIGURES = figures
30STYLESHEET = *.css
31
32##
33# These URI should be rewritten by your distribution's xml catalog to
34# match your localy installed XSL stylesheets.
35XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
36XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
37
38all: html pdf tarball
39
40pdf:
41 ../tools/poky-docbook-to-pdf adt-manual.xml ../template
42
43##
44# These URI should be rewritten by your distribution's xml catalog to
45# match your localy installed XSL stylesheets.
46
47html:
48# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
49
50# xsltproc $(XSLTOPTS) -o adt-manual.html $(XSL_XHTML_URI) adt-manual.xml
51 xsltproc $(XSLTOPTS) -o adt-manual.html adt-manual-customization.xsl adt-manual.xml
52
53tarball: html
54 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
55
56validate:
57 xmllint --postvalid --xinclude --noout adt-manual.xml
58
59publish:
60 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
61 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
62
63clean:
64 rm -f $(MANUALS)
diff --git a/documentation/bsp-guide/Makefile b/documentation/bsp-guide/Makefile
deleted file mode 100644
index 8071e348fb..0000000000
--- a/documentation/bsp-guide/Makefile
+++ /dev/null
@@ -1,58 +0,0 @@
1# You must call this Makefile using the following form:
2#
3# make
4# make html
5# make pdf
6# make tarball
7# make clean
8# make publish
9#
10# "make" creates the HTML, PDF, and tarballs.
11# "make html" creates just the HTML
12# "make pdf" creates just the PDF
13# "make tarball" creates the tarball
14# "make clean" removes the HTML and PDF files
15# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
16#
17
18XSLTOPTS = --stringparam html.stylesheet style.css \
19 --stringparam chapter.autolabel 1 \
20 --stringparam section.autolabel 1 \
21 --stringparam section.label.includes.component.label 1 \
22 --xinclude
23
24VER = 1.0
25DOC = bsp-guide
26ALLPREQ = html pdf tarball
27TARFILES = bsp-guide.html bsp-guide.pdf style.css figures/bsp-title.png
28MANUALS = $(DOC).html $(DOC).pdf
29FIGURES = figures
30STYLESHEET = *.css
31
32##
33# These URI should be rewritten by your distribution's xml catalog to
34# match your localy installed XSL stylesheets.
35XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
36XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
37
38all: html pdf tarball
39
40pdf:
41 ../tools/poky-docbook-to-pdf bsp-guide.xml ../template
42
43html:
44# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
45 xsltproc $(XSLTOPTS) -o bsp-guide.html bsp-guide-customization.xsl bsp-guide.xml
46
47tarball: html
48 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
49
50validate:
51 xmllint --postvalid --xinclude --noout bsp-guide.xml
52
53publish:
54 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
55 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
56
57clean:
58 rm -f $(MANUALS)
diff --git a/documentation/kernel-manual/Makefile b/documentation/kernel-manual/Makefile
deleted file mode 100644
index 2d9cc98c18..0000000000
--- a/documentation/kernel-manual/Makefile
+++ /dev/null
@@ -1,65 +0,0 @@
1# You must call this Makefile using the following form:
2#
3# make
4# make html
5# make pdf
6# make tarball
7# make clean
8# make publish
9#
10# "make" creates the HTML, PDF, and tarballs.
11# "make html" creates just the HTML
12# "make pdf" creates just the PDF
13# "make tarball" creates the tarball
14# "make clean" removes the HTML and PDF files
15# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
16#
17
18XSLTOPTS = --stringparam html.stylesheet style.css \
19 --stringparam chapter.autolabel 1 \
20 --stringparam appendix.autolabel A \
21 --stringparam section.autolabel 1 \
22 --stringparam section.label.includes.component.label 1 \
23 --xinclude
24
25VER = 1.0
26DOC = kernel-manual
27ALLPREQ = html pdf tarball
28TARFILES = kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
29MANUALS = $(DOC).html $(DOC).pdf
30FIGURES = figures
31STYLESHEET = *.css
32
33##
34# These URI should be rewritten by your distribution's xml catalog to
35# match your localy installed XSL stylesheets.
36XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
37XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
38
39all: html pdf tarball
40
41pdf:
42 ../tools/poky-docbook-to-pdf kernel-manual.xml ../template
43
44##
45# These URI should be rewritten by your distribution's xml catalog to
46# match your localy installed XSL stylesheets.
47
48html:
49# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
50
51# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml
52 xsltproc $(XSLTOPTS) -o kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml
53
54tarball: html
55 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
56
57validate:
58 xmllint --postvalid --xinclude --noout kernel-manual.xml
59
60publish:
61 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
62 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
63
64clean:
65 rm -f $(MANUALS)
diff --git a/documentation/kernel-manual/yocto-project-kernel-manual-customization.xsl b/documentation/kernel-manual/kernel-manual-customization.xsl
index 8eb69050ba..8eb69050ba 100644
--- a/documentation/kernel-manual/yocto-project-kernel-manual-customization.xsl
+++ b/documentation/kernel-manual/kernel-manual-customization.xsl
diff --git a/documentation/poky-ref-manual/Makefile b/documentation/poky-ref-manual/Makefile
deleted file mode 100644
index eff947c6ee..0000000000
--- a/documentation/poky-ref-manual/Makefile
+++ /dev/null
@@ -1,61 +0,0 @@
1# You must call this Makefile using the following form:
2#
3# make
4# make html
5# make pdf
6# make tarball
7# make clean
8# make publish
9#
10# "make" creates the HTML, PDF, and tarballs.
11# "make html" creates just the HTML
12# "make pdf" creates just the PDF
13# "make tarball" creates the tarball
14# "make clean" removes the HTML and PDF files
15# "make publish" pushes the HTML, PDF, figures, and stylesheet to the web server
16#
17
18XSLTOPTS = --stringparam html.stylesheet style.css \
19 --stringparam chapter.autolabel 1 \
20 --stringparam appendix.autolabel A \
21 --stringparam section.autolabel 1 \
22 --stringparam section.label.includes.component.label 1 \
23 --xinclude
24
25VER = 1.0
26DOC = poky-ref-manual
27ALLPREQ = html pdf tarball
28TARFILES = poky-ref-manual.html poky-ref-manual.pdf style.css figures/yocto-project-transp.png figures/poky-ref-manual.png screenshots/ss-sato.png
29MANUALS = $(DOC).html $(DOC).pdf
30FIGURES = figures
31SCREENSHOTS = screenshots
32STYLESHEET = *.css
33
34##
35# These URI should be rewritten by your distribution's xml catalog to
36# match your localy installed XSL stylesheets.
37XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
38XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
39
40all: html pdf tarball
41
42pdf:
43 ../tools/poky-docbook-to-pdf poky-ref-manual.xml ../template
44
45html:
46# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
47 xsltproc $(XSLTOPTS) -o poky-ref-manual.html poky-ref-manual-customization.xsl poky-ref-manual.xml
48
49tarball: html
50 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
51
52validate:
53 xmllint --postvalid --xinclude --noout poky-ref-manual.xml
54
55publish:
56 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
57 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
58 scp -r $(SCREENSHOTS) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/screenshots
59
60clean:
61 rm -f $(MANUALS)
diff --git a/documentation/yocto-project-qs/Makefile b/documentation/yocto-project-qs/Makefile
deleted file mode 100644
index c58a8e914f..0000000000
--- a/documentation/yocto-project-qs/Makefile
+++ /dev/null
@@ -1,53 +0,0 @@
1# You must call this Makefile using the following form:
2#
3# make
4# make html
5# make tarball
6# make clean
7# make publish
8#
9# "make" creates the HTML and tarball.
10# "make html" creates just the HTML
11# "make tarball" creates the tarball
12# "make clean" removes the HTML file
13# "make publish" pushes the HTML, figures, and stylesheet to the web server
14#
15
16XSLTOPTS = --stringparam html.stylesheet style.css \
17 --xinclude
18
19VER = 1.0
20DOC = yocto-quick-start
21ALLPREQ = html pdf tarball
22TARFILES = 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
23MANUALS = yocto-project-qs.html
24FIGURES = figures
25STYLESHEET = *.css
26
27XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
28XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
29
30all: html tarball
31
32##
33# These URI should be rewritten by your distribution's xml catalog to
34# match your localy installed XSL stylesheets.
35
36html:
37# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
38
39# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml
40 xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml
41
42tarball: html
43 cd $(DOC); tar -cvzf yocto-project-qs.tgz $(TARFILES); cd ..
44
45validate:
46 xmllint --postvalid --xinclude --noout yocto-project-qs.xml
47
48publish:
49 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)
50 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/$(VER)/$(DOC)/figures
51
52clean:
53 rm -f $(MANUALS)