summaryrefslogtreecommitdiffstats
path: root/documentation
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-06-13 22:38:03 +0100
commit37eedd0ae3593f759a5e9e70e9dc1191171e09d0 (patch)
treeca2ae81c1163b3bdd7763d2e0dfcc5df282e5b72 /documentation
parentbaf6bf4a5de176a5ad0fbaf436134c767eeed9ac (diff)
downloadpoky-37eedd0ae3593f759a5e9e70e9dc1191171e09d0.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: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile84
-rw-r--r--documentation/adt-manual/Makefile44
-rw-r--r--documentation/bsp-guide/Makefile37
-rw-r--r--documentation/kernel-manual/Makefile38
-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/Makefile38
-rw-r--r--documentation/yocto-project-qs/Makefile34
7 files changed, 84 insertions, 191 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 fe16a57f35..0000000000
--- a/documentation/adt-manual/Makefile
+++ /dev/null
@@ -1,44 +0,0 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --stringparam chapter.autolabel 1 \
3 --stringparam appendix.autolabel A \
4 --stringparam section.autolabel 1 \
5 --stringparam section.label.includes.component.label 1 \
6 --xinclude
7
8##
9# These URI should be rewritten by your distribution's xml catalog to
10# match your localy installed XSL stylesheets.
11XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
12XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
13
14all: html pdf tarball
15
16pdf:
17 ../tools/poky-docbook-to-pdf adt-manual.xml ../template
18
19##
20# These URI should be rewritten by your distribution's xml catalog to
21# match your localy installed XSL stylesheets.
22
23html:
24# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
25
26# xsltproc $(XSLTOPTS) -o adt-manual.html $(XSL_XHTML_URI) adt-manual.xml
27 xsltproc $(XSLTOPTS) -o adt-manual.html adt-manual-customization.xsl adt-manual.xml
28
29tarball: html
30 tar -cvzf adt-manual.tgz adt-manual.html adt-manual.pdf style.css figures/adt-title.png
31
32validate:
33 xmllint --postvalid --xinclude --noout adt-manual.xml
34
35MANUALS = adt-manual.html adt-manual.pdf
36FIGURES = figures/*.png
37STYLESHEET = *.css
38
39publish:
40 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/adt-manual
41 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/adt-manual/figures
42
43clean:
44 rm -f $(MANUALS)
diff --git a/documentation/bsp-guide/Makefile b/documentation/bsp-guide/Makefile
deleted file mode 100644
index 36ca48a62a..0000000000
--- a/documentation/bsp-guide/Makefile
+++ /dev/null
@@ -1,37 +0,0 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --stringparam chapter.autolabel 1 \
3 --stringparam section.autolabel 1 \
4 --stringparam section.label.includes.component.label 1 \
5 --xinclude
6
7##
8# These URI should be rewritten by your distribution's xml catalog to
9# match your localy installed XSL stylesheets.
10XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
11XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
12
13all: html pdf tarball
14
15pdf:
16 ../tools/poky-docbook-to-pdf bsp-guide.xml ../template
17
18html:
19# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
20 xsltproc $(XSLTOPTS) -o bsp-guide.html bsp-guide-customization.xsl bsp-guide.xml
21
22tarball: html
23 tar -cvzf bsp-guide.tgz style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
24
25validate:
26 xmllint --postvalid --xinclude --noout bsp-guide.xml
27
28MANUALS = bsp-guide.html bsp-guide.pdf
29FIGURES = figures/*.png
30STYLESHEET = *.css
31
32publish:
33 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/bsp-guide
34 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/bsp-guide/figures
35
36clean:
37 rm -f $(OUTPUTS)
diff --git a/documentation/kernel-manual/Makefile b/documentation/kernel-manual/Makefile
deleted file mode 100644
index b691da8111..0000000000
--- a/documentation/kernel-manual/Makefile
+++ /dev/null
@@ -1,38 +0,0 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --stringparam chapter.autolabel 1 \
3 --stringparam appendix.autolabel A \
4 --stringparam section.autolabel 1 \
5 --stringparam section.label.includes.component.label 1 \
6 --xinclude
7
8##
9# These URI should be rewritten by your distribution's xml catalog to
10# match your localy installed XSL stylesheets.
11XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
12XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
13
14all: html pdf tarball
15
16pdf:
17 ../tools/poky-docbook-to-pdf kernel-manual.xml ../template
18
19html:
20# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
21 xsltproc $(XSLTOPTS) -o kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml
22
23tarball: html
24 tar -cvzf kernel-manual.tgz kernel-manual.html kernel-manual.pdf style.css figures/kernel-title.png figures/kernel-architecture-overview.png
25
26validate:
27 xmllint --postvalid --xinclude --noout kernel-manual.xml
28
29MANUALS = kernel-manual.html kernel-manual.pdf
30FIGURES = figures/*.png
31STYLESHEET = *.css
32
33publish:
34 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/kernel-manual
35 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/kernel-manual/figures
36
37clean:
38 rm -f $(OUTPUTS)
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 bb70a05d87..0000000000
--- a/documentation/poky-ref-manual/Makefile
+++ /dev/null
@@ -1,38 +0,0 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --stringparam chapter.autolabel 1 \
3 --stringparam appendix.autolabel A \
4 --stringparam section.autolabel 1 \
5 --stringparam section.label.includes.component.label 1 \
6 --xinclude
7
8##
9# These URI should be rewritten by your distribution's xml catalog to
10# match your localy installed XSL stylesheets.
11XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
12XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
13
14all: html pdf tarball
15
16pdf:
17 ../tools/poky-docbook-to-pdf poky-ref-manual.xml ../template
18
19html:
20# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
21 xsltproc $(XSLTOPTS) -o poky-ref-manual.html poky-ref-manual-customization.xsl poky-ref-manual.xml
22
23tarball: html
24 tar -cvzf poky-ref-manual.tgz poky-ref-manual.html style.css figures/poky-title.png figures/ss-sato.png
25
26validate:
27 xmllint --postvalid --xinclude --noout poky-ref-manual.xml
28
29MANUALS = poky-ref-manual.html poky-ref-manual.pdf
30FIGURES = figures/*.png
31STYLESHEET = *.css
32
33publish:
34 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/poky-ref-manual
35 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/poky-ref-manual/figures
36
37clean:
38 rm -f $(OUTPUTS)
diff --git a/documentation/yocto-project-qs/Makefile b/documentation/yocto-project-qs/Makefile
deleted file mode 100644
index 2c7bdf86a0..0000000000
--- a/documentation/yocto-project-qs/Makefile
+++ /dev/null
@@ -1,34 +0,0 @@
1XSLTOPTS = --stringparam html.stylesheet style.css \
2 --xinclude
3
4XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
5XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
6
7all: html tarball
8
9##
10# These URI should be rewritten by your distribution's xml catalog to
11# match your localy installed XSL stylesheets.
12
13html:
14# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
15
16# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml
17 xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml
18
19tarball: html
20 tar -cvzf yocto-project-qs.tgz 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
21
22validate:
23 xmllint --postvalid --xinclude --noout yocto-project-qs.xml
24
25MANUALS = yocto-project-qs.html
26FIGURES = figures/*.png
27STYLESHEET = *.css
28
29publish:
30 scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/yocto-quick-start
31 scp -r $(FIGURES) www.yoctoproject.org:/srv/www/www.yoctoproject.org-docs/yocto-quick-start/figures
32
33clean:
34 rm -f $(MANUALS)
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-18 02:45:28 +0000