Skip to contentSkip to conversation

Fixing documentation publishing/makefiles

PATCH New Elizabeth Flanagan 1 participant 1 message May 24, 2011

lore
Share & tools
lore
#0 lore raw

cover Fixing documentation publishing/makefiles

[YOCTO #1025]

This patch mostly fixes the issues around 1025 and should be brought into master, bernard and the poky-documentation repo.

Before we try to publish with this, however, the main docs page on the webserver will need to be corrected.

A few issues have cropped up with documentation. 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> DISTROVERSION=<MM.mm>

make all DOC=kernel-manual DISTROVERSION=1.1

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.

The following changes since commit 3504c3a9b1af5a3405e0a03a5ade50b82535b6dd:

documentation/yocto-project-qs/yocto-project-qs.xml: fixed build env script (2011-05-23 15:53:29 +0100)

are available in the git repository at:
git://git.pokylinux.org/poky-contrib.git eflanagan/documentation_release_fixes
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=eflanagan/documentation_release_fixes

Beth Flanagan (1):
documentation: Fixing the build system for docs

 documentation/{poky-ref-manual => }/Makefile       |   18 ++++----
 documentation/adt-manual/Makefile                  |   44 --------------------
 documentation/bsp-guide/Makefile                   |   37 ----------------
 documentation/kernel-manual/Makefile               |   38 -----------------
 ...ization.xsl => kernel-manual-customization.xsl} |    0
 documentation/yocto-project-qs/Makefile            |   34 ---------------
 6 files changed, 9 insertions(+), 162 deletions(-)
 rename documentation/{poky-ref-manual => }/Makefile (57%)
 delete mode 100644 documentation/adt-manual/Makefile
 delete mode 100644 documentation/bsp-guide/Makefile
 delete mode 100644 documentation/kernel-manual/Makefile
 rename documentation/kernel-manual/{yocto-project-kernel-manual-customization.xsl => kernel-manual-customization.xsl} 
(100%)
 delete mode 100644 documentation/yocto-project-qs/Makefile