summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-15 15:31:13 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-23 14:24:48 +0000
commit542d163b5c203ed08e00a71aaac7e7e60cdd9af6 (patch)
treed1b3fc4510e1cfd40a18456412e45df0bcbc42f7 /documentation/README
parent0f25a65a2646a8dd5157285f0e5555a17b5dabd9 (diff)
downloadpoky-542d163b5c203ed08e00a71aaac7e7e60cdd9af6.tar.gz
poky-542d163b5c203ed08e00a71aaac7e7e60cdd9af6.tar.bz2
poky-542d163b5c203ed08e00a71aaac7e7e60cdd9af6.zip
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 <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README29
1 files changed, 27 insertions, 2 deletions
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
===================