summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-15 21:31:13 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-23 14:24:48 (GMT)
commit542d163b5c203ed08e00a71aaac7e7e60cdd9af6 (patch)
treed1b3fc4510e1cfd40a18456412e45df0bcbc42f7 /documentation/README
parent0f25a65a2646a8dd5157285f0e5555a17b5dabd9 (diff)
downloadpoky-542d163b5c203ed08e00a71aaac7e7e60cdd9af6.tar.gz
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 5f41f79..2536d9a 100644
--- a/documentation/README
+++ b/documentation/README
@@ -1,8 +1,33 @@
1documentation 1documentation
2============= 2=============
3 3
4This is the location for the Yocto Project documentation. Documentation 4This is the directory that contains the Yocto Project documentation. The Yocto
5consists of six manuals (see below). 5Project source repositories at http://git.yoctoproject.org/cgit.cgi have two
6instances of the "documentation" directory. You should understand each of
7these instances.
8
9 poky/documentation - The directory within the poky Git repository containing
10 the set of Yocto Project manuals. When you clone the
11 poky Git repository, the documentation directory
12 contains the manuals. The state of the manuals in this
13 directory is guaranteed to reflect the latest Yocto
14 Project release. The manuals at the tip of this
15 directory will also likely contain most manual
16 development changes.
17
18 yocto-docs/documentation - The Git repository for the Yocto Project manuals.
19 This repository is where manual development
20 occurs. If you plan on contributing back to the
21 Yocto Project documentation, you should set up
22 a local Git repository based on this upstream
23 repository as follows:
24
25 git clone git://git.yoctoproject.org/yocto-docs
26
27 Changes and patches are first pushed to the
28 yocto-docs Git repository. Later, they make it
29 into the poky Git repository found at
30 git://git.yoctoproject.org/poky.
6 31
7Manual Organization 32Manual Organization
8=================== 33===================