@@ -1,33 +1,14 @@
documentation
=============
-This is the directory that contains the Yocto Project documentation. The Yocto
-Project source repositories at https://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.
+This is the directory that contains the Yocto Project documentation. The Yocto
+Project documentation is hosted at https://git.yoctoproject.org/yocto-docs:
+
+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
Manual Organization
===================
@@ -261,9 +242,9 @@ For example, the following .rst content will produce the 'expected'
content:
.. code-block::
- $ mkdir poky-&DISTRO;
+ $ mkdir project-&DISTRO;
or
- $ git clone &YOCTO_GIT_URL;/git/poky -b &DISTRO_NAME_NO_CAP;
+ $ git clone &YOCTO_GIT_URL;/git/yocto-docs -b &DISTRO_NAME_NO_CAP;
Variables can be nested, like it was the case for DocBook:
Refresh the document now that the Poky repository is obsolete. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- documentation/README | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-)