diff options
| author |   Devan Franchini <twitch153@gentoo.org> | 2014-06-10 18:12:35 -0400 |
|---|---|---|
| committer | Devan Franchini <twitch153@gentoo.org> | 2014-06-14 20:36:39 -0400 |
| commit | be9e55df8c896cd8d7a4093fd8e440cf8c79c2b6 (patch) | |
| tree | 57a4882c82f3fb71fcf1ae339c895ac6c47a12df /doc | |
| parent | Various syntax fixes (diff) | |
| download | layman-be9e55df8c896cd8d7a4093fd8e440cf8c79c2b6.tar.gz layman-be9e55df8c896cd8d7a4093fd8e440cf8c79c2b6.tar.bz2 layman-be9e55df8c896cd8d7a4093fd8e440cf8c79c2b6.zip | |
Replaces "subpath" with "branch"
In favor of a more widely used varaible, the subpath variable has
been replaced with branch. In preparation for branch support in
overlay.xml files.
layman.8.txt: An example of an overlay.xml with a branch in it has
been added for users along with pointers to using the variable.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/layman.8.txt | 31 |
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 ~~~~~~~~~~~~~~~~~~~~~~~~~ |