various enhancement to man pages

This commit is contained in:
Miroslav Suchý 2013-04-24 22:57:10 +02:00
parent 23faae8487
commit 25d8e44339
4 changed files with 40 additions and 16 deletions

View file

@ -9,3 +9,7 @@ Jesus M Rodriguez <jesusr@redhat.com>
Pall Sigurdsson <palli@opensource.is> Pall Sigurdsson <palli@opensource.is>
Miroslav Suchý <msuchy@redhat.com> Miroslav Suchý <msuchy@redhat.com>
and: Adam Miller, Alex Wood, Aron Parsons, Brenton Leanhardt, Ivan Nečas, John Eckersberg,
Kenny MacDermid, Lukáš Zapletal, Luke Meyer, Marian Csontos, Martin Bačovský, Michael Stead,
Mike McCune, mscherer, Paul Morgan, Sean P. Kane, Steve 'Ashcrow' Milner

View file

@ -6,10 +6,10 @@ NAME
---- ----
releasers.conf - Config file defining release targets where builds can be published. releasers.conf - Config file defining release targets where builds can be published.
SYNOPSIS SYNOPSIS
-------- --------
None None
// older asciidoc versions (such as the version for .el5) require a synopsis section
DESCRIPTION DESCRIPTION
@ -26,29 +26,39 @@ Specify "builder.test = 1" in your releasers.conf target to enable --test builds
tito.release.YumRepoReleaser:: tito.release.YumRepoReleaser::
Releaser which will build your packages, rsync down an existing yum repository, place your packages in it, regenerate the yum repodata, and rsync the yum repository back up. Releaser which will build your packages, rsync down an existing yum repository, place your packages in it, regenerate the yum repodata, and rsync the yum repository back up.
+
Specify "filetypes = srpm" if you want to build a source rpm instead of a regular rpm. Specify "filetypes = srpm" if you want to build a source rpm instead of a regular rpm.
+
Specify "createrepo_command = createrepo -s sha1" if you are building on a recent distro and are working with yum repositories for rhel5. Specify "createrepo_command = createrepo -s sha1" if you are building on a recent distro and are working with yum repositories for rhel5.
+
You can use environment variable RSYNC_USERNAME to override rsync username. You can use environment variable RSYNC_USERNAME to override rsync username.
tito.release.RsyncReleaser:: tito.release.RsyncReleaser::
Releaser which will build your packages, and rsync up to a remote repository. Releaser which will build your packages, and rsync up to a remote repository.
+
Specify "filetypes = rpm srpm tgz" to choose what type of packages will be uploaded. Specify "filetypes = rpm srpm tgz" to choose what type of packages will be uploaded.
+
You can use environment variable RSYNC_USERNAME to override rsync username. You can use environment variable RSYNC_USERNAME to override rsync username.
+
Specify "scl = COLLECTION" to build into Software Collection. Specify "scl = COLLECTION" to build into Software Collection.
+
Variable "rsync_args" can specify addiontal argument passed to rsync. Default is "-rlvz".
tito.release.FedoraGitReleaser:: tito.release.FedoraGitReleaser::
Releaser which will checkout your project in Fedora git using fedpkg. Sources are then synced to the first branch your releaser lists. After this tito will git merge the first branch into all other listed branches, triggering builds in each. Releaser which will checkout your project in Fedora git using fedpkg. Sources are then synced to the first branch your releaser lists. After this tito will git merge the first branch into all other listed branches, triggering builds in each.
+
WARNING: Highly experimental, very prone to failure if merging master into your branches is likely to cause a conflict. You will need to cleanup manually if this occurs. WARNING: Highly experimental, very prone to failure if merging master into your branches is likely to cause a conflict. You will need to cleanup manually if this occurs.
+
[fedora-git] [fedora-git]
releaser = tito.release.FedoraGitReleaser releaser = tito.release.FedoraGitReleaser
branches = master el5 el6 f14 f15 f16 branches = master el5 el6 f14 f15 f16
tito.release.DistGitReleaser::
Same as FedoraGitReleaser, but use rhpkg instead of fedpkg.
tito.release.CvsReleaser:: tito.release.CvsReleaser::
Releaser which will submit builds through CVS build systems. (no longer useful for Fedora) The CVS module is checked out, sources, spec file, and patches are synced and committed, the release is tagged (make tag), and then submitted to the build system. (make build) Releaser which will submit builds through CVS build systems. (no longer useful for Fedora) The CVS module is checked out, sources, spec file, and patches are synced and committed, the release is tagged (make tag), and then submitted to the build system. (make build)
+
[cvs] [cvs]
releaser = tito.release.CvsReleaser releaser = tito.release.CvsReleaser
cvsroot = :ext:myuser@cvs.fedoraproject.org:/cvs/extra cvsroot = :ext:myuser@cvs.fedoraproject.org:/cvs/extra
@ -71,6 +81,14 @@ You can specify KOJI_OPTIONS in titorc(5) and it is passed to koji command as op
+ +
Variable autobuild_tags is required for KojiReleaser. Variable autobuild_tags is required for KojiReleaser.
tito.release.KojiGitReleaser::
Build into Koji through dist-git. It behaves as KojiReleaser. Only difference is that src.rpm is not passed to Koji. Instead is sent to koji git hash from which Koji should build package.
+
Note: This feature is not in upstream Koji (although is submited for long time).
+
Please do not confuse with FedoraGitReleaser. KojiGitReleaser is intended for private instances of Koji.
+
You need to specify git_url, which specify url of git repository. This url needs to be reachable from Koji.
EXAMPLE EXAMPLE
------- -------

View file

@ -4,8 +4,7 @@ include::man.asciidoc[]
NAME NAME
---- ----
tito.props - Settings file for whole git repository with multiple packages. tito.props - directives for tito(5) how to build package.
build.py.props - Setting file in package directory, which override values in tito.props
SYNOPSIS SYNOPSIS
@ -37,21 +36,15 @@ default builder and tagger for you project. You can use following variables:
default_builder:: default_builder::
The fully qualified Builder class implementation to use. The fully qualified Builder class implementation to use.
You can either specify builders shipped with Tito (see BUILDERS section below), or a custom builder located within the directory your `lib_dir` option points to. You can either specify builders shipped with tito(5) (see BUILDERS section below), or a custom builder located within the directory your `lib_dir` option points to.
default_tagger:: default_tagger::
The fully qualified Tagger class implementation to use. The fully qualified Tagger class implementation to use.
You can either specify builders shipped with Tito (see TAGGERS section below), or a custom builder located within the directory your `lib_dir` option points to. You can either specify builders shipped with tito(5) (see TAGGERS section below), or a custom builder located within the directory your `lib_dir` option points to.
lib_dir:: lib_dir::
Optional property defining a directory to be added to the Python path when executing tito. Allows you to store custom implementations of Builder, Tagger, and Releaser. Optional property defining a directory to be added to the Python path when executing tito. Allows you to store custom implementations of Builder, Tagger, and Releaser.
builder::
This option is used in project specific tito.props only, and allows that project to override the default_builder defined in rel-eng/tito.props.
tagger::
This option is used in project specific tito.props only, and allows that project to override the default_tagger defined in rel-eng/tito.props.
changelog_format:: changelog_format::
This option is used to control the formatting of entries when This option is used to control the formatting of entries when
generating changelog entries. The default value is "%s (%ae)". See generating changelog entries. The default value is "%s (%ae)". See
@ -106,6 +99,15 @@ REQUIREMENTS
tito:: tito::
If tito is older then specified version, it will refuse to continue. If tito is older then specified version, it will refuse to continue.
BUILDCONFIG
-----------
builder::
This option is used in package specific tito.props only, and allows that project to override the default_builder defined in rel-eng/tito.props.
tagger::
This option is used in package specific tito.props only, and allows that project to override the default_tagger defined in rel-eng/tito.props.
TAGCONFIG TAGCONFIG
--------- ---------
require_package:: require_package::

View file

@ -26,7 +26,7 @@ KOJI_OPTIONS::
Specify strings of options, which is passed to koji on commandline when you Specify strings of options, which is passed to koji on commandline when you
use KojiReleaser. For example: use KojiReleaser. For example:
KOJI_OPTIONS=-c ~/.koji/katello-config --nowait KOJI_OPTIONS=-c ~/.koji/katello-config build --nowait
NO_AUTO_INSTALL:: NO_AUTO_INSTALL::
Specify list of packages (separated by space), which should NOT be installed, Specify list of packages (separated by space), which should NOT be installed,