From 542d163b5c203ed08e00a71aaac7e7e60cdd9af6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 15 Mar 2012 15:31:13 -0600 Subject: documentation/README: Updates to explain development I added information that describes the relationship between poky/documentation and yocto-docs/documentation. For developers, they need to know to work from the yocto-docs Git repository and not to rely on the poky/documentation Git repository, which can lag behind the other one. (From yocto-docs rev: 0cbc781d3e9544c9920fdaf4548d882dd79b3d6c) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/README | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README index 5f41f79c37..2536d9ad9b 100644 --- a/documentation/README +++ b/documentation/README @@ -1,8 +1,33 @@ documentation ============= -This is the location for the Yocto Project documentation. Documentation -consists of six manuals (see below). +This is the directory that contains the Yocto Project documentation. The Yocto +Project source repositories at http://git.yoctoproject.org/cgit.cgi have two +instances of the "documentation" directory. You should understand each of +these instances. + + poky/documentation - The directory within the poky Git repository containing + the set of Yocto Project manuals. When you clone the + poky Git repository, the documentation directory + contains the manuals. The state of the manuals in this + directory is guaranteed to reflect the latest Yocto + Project release. The manuals at the tip of this + directory will also likely contain most manual + development changes. + + yocto-docs/documentation - The Git repository for the Yocto Project manuals. + This repository is where manual development + occurs. If you plan on contributing back to the + Yocto Project documentation, you should set up + a local Git repository based on this upstream + repository as follows: + + git clone git://git.yoctoproject.org/yocto-docs + + Changes and patches are first pushed to the + yocto-docs Git repository. Later, they make it + into the poky Git repository found at + git://git.yoctoproject.org/poky. Manual Organization =================== -- cgit v1.2.3-54-g00ecf