[eit] add "eit init", "eit deps" man pages

This commit is contained in:
Fabio Erculiani
2011-11-19 18:13:34 +01:00
parent 4e7a895938
commit c44cb0195d
5 changed files with 157 additions and 2 deletions

View File

@@ -0,0 +1,65 @@
eit-deps(1)
===========
:man source: eit {eitversion}
:man manual: eit {eitversion}
NAME
----
eit-deps - edit dependencies for packages in repository
SYNOPSIS
--------
eit deps [-h] [--in <repository>] <package> [<package> ...]
INTRODUCTION
------------
Through this tool it's possible to add, remove and edit dependencies of
any package.
This might be helpful for small tweaks or trivial changes in order to
avoid a complete repackage.
Please do not abuse it, package file metadata are not updated accordingly,
and the same is for Source Package Manager metadata.
Consider this a last resort for updating package dependencies in a
non-permanent way.
OPTIONS
-------
"eit deps" supports the following options which alters its behaviour.
POSITIONAL ARGUMENTS
~~~~~~~~~~~~~~~~~~~~
*<package>*::
package name
OPTIONAL ARGUMENTS
~~~~~~~~~~~~~~~~~~
*--help*::
show this help message and exit
*--in*=<repository>::
inject into given repository
AUTHORS
-------
Eit has been accidentally prototyped during a rainy Sunday by Fabio
Erculiani who was looking for innovative ways of handling package
bumps in Sabayon Entropy repositories.
A few months later, Eit saw the light.
REPORTING BUGS
--------------
Report bugs to https://bugs.sabayon.org or directly to the author at
lxnay@sabayon.org.
SEE ALSO
--------
eit(1)

View File

@@ -0,0 +1,60 @@
eit-init(1)
===========
:man source: eit {eitversion}
:man manual: eit {eitversion}
NAME
----
eit-init - initialize repository (erasing all its content)
SYNOPSIS
--------
eit init [-h] [--quick] <repo>
INTRODUCTION
------------
Initialize a given repository. The same must be already configured
in */etc/entropy/server.conf* for this tool to work as expected.
So, please setup your repository there and only then run *eit init <repo>*.
OPTIONS
-------
"eit init" supports the following options which alters its behaviour.
POSITIONAL ARGUMENTS
~~~~~~~~~~~~~~~~~~~~
*<repo>*::
repository
OPTIONAL ARGUMENTS
~~~~~~~~~~~~~~~~~~
*--help*::
show this help message and exit
*--quick*::
no stupid questions
AUTHORS
-------
Eit has been accidentally prototyped during a rainy Sunday by Fabio
Erculiani who was looking for innovative ways of handling package
bumps in Sabayon Entropy repositories.
A few months later, Eit saw the light.
REPORTING BUGS
--------------
Report bugs to https://bugs.sabayon.org or directly to the author at
lxnay@sabayon.org.
SEE ALSO
--------
eit(1)

View File

@@ -162,6 +162,7 @@ lxnay@sabayon.org.
SEE ALSO
--------
eit-add(1), eit-branch(1), eit-bump(1), eit-checkout(1), eit-cleanup(1)
eit-commit(1), eit-cp(1), eit-files(1), eit-graph(1), eit-log(1)
eit-mv(1), eit-notice(1), eit-own(1), eit-repack(1), eit-revgraph(1)
eit-commit(1), eit-cp(1), eit-deps(1), eit-files(1), eit-graph(1)
eit-init(1), eit-log(1), eit-mv(1), eit-notice(1), eit-own(1)
eit-repack(1), eit-revgraph(1)

View File

@@ -48,6 +48,23 @@ class EitDeps(EitCommand):
return parser
INTRODUCTION = """\
Through this tool it's possible to add, remove and edit dependencies of
any package.
This might be helpful for small tweaks or trivial changes in order to
avoid a complete repackage.
Please do not abuse it, package file metadata are not updated accordingly,
and the same is for Source Package Manager metadata.
Consider this a last resort for updating package dependencies in a
non-permanent way.
"""
def man(self):
"""
Overridden from EitCommand.
"""
return self._man()
def parse(self):
parser = self._get_parser()
try:

View File

@@ -83,6 +83,18 @@ class EitInit(EitCommand):
sys.stdout.write(" ".join(outcome) + "\n")
sys.stdout.flush()
INTRODUCTION = """\
Initialize a given repository. The same must be already configured
in */etc/entropy/server.conf* for this tool to work as expected.
So, please setup your repository there and only then run *eit init <repo>*.
"""
def man(self):
"""
Overridden from EitCommand.
"""
return self._man()
def parse(self):
""" Overridden from EitInit """
parser = self._get_parser()