diff options
author | Beth Flanagan <elizabeth.flanagan@intel.com> | 2011-06-02 10:18:35 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-12-20 22:35:16 +0000 |
commit | a02537187fcf131f1b97ec38d6f88a1ae82649fa (patch) | |
tree | a2020aa4a09031610aea55522494d4aa98bbda9d /documentation/yocto-project-qs | |
parent | 78d092fe7a6b12e737ddc7c9564a72ad85a8a3c9 (diff) | |
download | poky-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>
Diffstat (limited to 'documentation/yocto-project-qs')
-rw-r--r-- | documentation/yocto-project-qs/Makefile | 53 |
1 files changed, 0 insertions, 53 deletions
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 | |||
16 | XSLTOPTS = --stringparam html.stylesheet style.css \ | ||
17 | --xinclude | ||
18 | |||
19 | VER = 1.0 | ||
20 | DOC = yocto-quick-start | ||
21 | ALLPREQ = html pdf tarball | ||
22 | 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 | ||
23 | MANUALS = yocto-project-qs.html | ||
24 | FIGURES = figures | ||
25 | STYLESHEET = *.css | ||
26 | |||
27 | XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current | ||
28 | XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl | ||
29 | |||
30 | all: 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 | |||
36 | html: | ||
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 | |||
42 | tarball: html | ||
43 | cd $(DOC); tar -cvzf yocto-project-qs.tgz $(TARFILES); cd .. | ||
44 | |||
45 | validate: | ||
46 | xmllint --postvalid --xinclude --noout yocto-project-qs.xml | ||
47 | |||
48 | publish: | ||
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 | |||
52 | clean: | ||
53 | rm -f $(MANUALS) | ||