All of lore.kernel.org
 help / color / mirror / Atom feed
From: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
To: "poky@yoctoproject.org" <poky@yoctoproject.org>
Subject: [PATCH 0/1] [DOCS] Fixing documentation publishing/makefiles
Date: Tue, 24 May 2011 11:39:24 -0700	[thread overview]
Message-ID: <4DDBFB5C.7090907@intel.com> (raw)

[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


                 reply	other threads:[~2011-05-24 18:39 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4DDBFB5C.7090907@intel.com \
    --to=elizabeth.flanagan@intel.com \
    --cc=poky@yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.