aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/layman.8.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/layman.8.txt b/doc/layman.8.txt
index fa75fac..0819570 100644
--- a/doc/layman.8.txt
+++ b/doc/layman.8.txt
@@ -445,6 +445,37 @@ Example 1. An example overlays.xml file
</repositories>
-------------------------------------------
+Example 2. An example overlays.xml file with a branch
+
+-------------------------------------------
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE repositories SYSTEM "/dtd/repositories.dtd">
+<repositories xmlns="" version="1.0">
+<repo quality="experimental" status="official">
+ <name><hardened-development></name>
+ <description><Development Overlay for Hardened Gcc 4.x Toolchain></description>
+ <homepage>http://git.overlays.gentoo.org/gitweb/?p=proj/hardened-dev.git;a=summary</homepage>
+ <owner type="project">
+ <email>hardened@gentoo.org</email>
+ </owner>
+ <source type="git">git://git.overlays.gentoo.org/proj/hardened-dev.git</source>
+ <branch>uclibc</branch>
+ <feed>http://git.overlays.gentoo.org/gitweb/?p=proj/hardened-dev.git;a=atom</feed>
+</repo>
+</repositories>
+
+Users can specify a branch for an overlay, given one actually exists.
+This logic is applicable to CVS overlays as well and the branch variable
+is comparable to specifying a subpath for a CVS repository.
+
+VCS types where the use of "branch" is supported is as follows::
+- CVS
+- Tar
+- Git
+- Mercurial
+However, for CVS and Tar overlays, the branch will be treated as a subpath.
+If you use the branch variable with any other overlay types aside from the ones
+listed, it will be ignored.
ADDING AN OVERLAY LOCALLY
~~~~~~~~~~~~~~~~~~~~~~~~~