[eit] add more man pages

- eit merge
- eit pkgmove
- eit push
- eit query
- eit remove
- eit repo
- eit reset
- eit test

server/doc/mansrc/eit-merge.1.txt

@@ -0,0 +1,67 @@
+eit-merge(1)
+============
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-merge - merge packages on other branches into current
+
+
+SYNOPSIS
+--------
+eit merge [-h] [--in <repository>] [--quick] <branch>
+
+
+INTRODUCTION
+------------
+When a repository is switched to a new branch, remote packages,
+for mirror size optimization reasons, are kept in current folders exposing
+the old branch as sub-directory and referenced from there until
+they get replaced into the repository. At some point in the future btw,
+older branches would be dismissed and packages in repository on the
+current branch referencing packages in older branches should be merged
+back in. This tool does exactly this.
+
+
+
+OPTIONS
+-------
+"eit merge" supports the following options which alters its behaviour.
+
+
+POSITIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~~~
+*<branch>*::
+    repository branch
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+*--in*=<repository>::
+    work inside given repository
+
+*--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)

server/doc/mansrc/eit-pkgmove.1.txt

@@ -0,0 +1,62 @@
+eit-pkgmove(1)
+==============
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-pkgmove - edit automatic package moves for repository
+
+
+SYNOPSIS
+--------
+eit pkgmove [-h] <repo>
+
+
+INTRODUCTION
+------------
+Packages can be renamed or get their SLOT changed over time (say
+thanks to Source Package Managers like Portage :-/).
+To ensure that Entropy Clients do update their metadata accordingly,
+any change done server-side is recorded into the repository itself.
+This tool makes possible to edit such "raw" metadata.
+The risk of completely disrupting Entropy Clients (and distro installs)
+is very high, use this tool *only, and only if* you know what you're
+doing.
+
+
+
+OPTIONS
+-------
+"eit pkgmove" supports the following options which alters its behaviour.
+
+
+POSITIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~~~
+*<repo>*::
+    repository
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+
+
+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)

server/doc/mansrc/eit-push.1.txt

@@ -0,0 +1,65 @@
+eit-push(1)
+===========
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-push - push (or pull) repository packages and metadata
+
+
+SYNOPSIS
+--------
+eit push [-h] [--quick] [--all | --as <repo>] [<repo>]
+
+
+INTRODUCTION
+------------
+Synchronize remote mirrors with local repository content (packages and
+repository).
+
+
+
+OPTIONS
+-------
+"eit push" 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
+
+*--all*::
+    push all the repositories
+
+*--as*=<repo>::
+    push as fake 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)

server/doc/mansrc/eit-query.1.txt

@@ -0,0 +1,68 @@
+eit-query(1)
+============
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-query - miscellaneous package metadata queries
+
+
+SYNOPSIS
+--------
+eit query [-h] {tags,needed,revdeps,sets,desc} ...
+
+
+INTRODUCTION
+------------
+Toolset containing all the Entropy Server built-in repository query
+tools.
+
+
+
+OPTIONS
+-------
+"eit query" supports the following options which alters its behaviour.
+
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+ACTION
+~~~~~~
+*tags*::
+    search package tags
+
+*needed*::
+    show libraries (.so) required by matched packages
+
+*revdeps*::
+    show reverse dependencies of packages
+
+*sets*::
+    search through package sets
+
+*desc*::
+    search packages through their description
+
+
+
+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)

server/doc/mansrc/eit-remove.1.txt

@@ -0,0 +1,65 @@
+eit-remove(1)
+=============
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-remove - remove packages from repository
+
+
+SYNOPSIS
+--------
+eit remove [-h] [--from <repository>] [--nodeps] [--quick]
+           <package> [<package> ...]
+
+
+INTRODUCTION
+------------
+Remove a package from repository. It's no-brainer actually.
+
+
+
+OPTIONS
+-------
+"eit remove" supports the following options which alters its behaviour.
+
+
+POSITIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~~~
+*<package>*::
+    package name
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+*--from*=<repository>::
+    inject into given repository
+
+*--nodeps*::
+    do not include reverse dependencies
+
+*--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), eit-add(1)

server/doc/mansrc/eit-repo.1.txt

@@ -0,0 +1,50 @@
+eit-repo(1)
+===========
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-repo - show current repository
+
+
+SYNOPSIS
+--------
+eit repo [-h]
+
+
+INTRODUCTION
+------------
+Show current repository, its branch and configured mirrors.
+
+
+
+OPTIONS
+-------
+"eit repo" supports the following options which alters its behaviour.
+
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+
+
+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), eit-status(1)

server/doc/mansrc/eit-reset.1.txt

@@ -0,0 +1,62 @@
+eit-reset(1)
+============
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-reset - reset repository to remote status
+
+
+SYNOPSIS
+--------
+eit reset [-h] [--quick] [--local] [<repo>]
+
+
+INTRODUCTION
+------------
+Discard all the changes made to the local repository by completely
+re-fetching the remote version available on mirrors.
+
+
+
+OPTIONS
+-------
+"eit reset" 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
+
+*--local*::
+    do not pull the remote 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)

server/doc/mansrc/eit-test.1.txt

@@ -0,0 +1,70 @@
+eit-test(1)
+===========
+:man source:   eit {eitversion}
+:man manual:   eit {eitversion}
+
+
+NAME
+----
+eit-test - run QA tests
+
+
+SYNOPSIS
+--------
+eit test [-h] {deps,libs,links,pkglibs,local,remote} ...
+
+
+INTRODUCTION
+------------
+Toolset containing all the Entropy Server built-in QA tests available.
+
+
+
+OPTIONS
+-------
+"eit test" supports the following options which alters its behaviour.
+
+
+OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~
+*--help*::
+    show this help message and exit
+
+TEST
+~~~~
+*deps*::
+    dependencies test
+
+*libs*::
+    libraries test
+
+*links*::
+    library linking test (using repository metadata)
+
+*pkglibs*::
+    library linking test (using live system)
+
+*local*::
+    verify local packages integrity
+
+*remote*::
+    verify remote packages integrity
+
+
+
+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)

server/doc/mansrc/eit.1.txt

@@ -94,7 +94,7 @@ COMMANDS
     match packages in repositories
 
 *merge*::
-    merge branch into current
+    merge packages on other branches into current
 
 *mv*::
     move packages from a repository to another
@@ -164,6 +164,8 @@ SEE ALSO
     eit-add(1), eit-branch(1), eit-bump(1), eit-checkout(1), eit-cleanup(1)
     eit-commit(1), eit-cp(1), eit-deps(1), eit-files(1), eit-graph(1)
     eit-init(1), eit-inject(1), eit-list(1), eit-lock(1), eit-log(1)
-    eit-match(1), eit-mv(1), eit-notice(1), eit-own(1), eit-repack(1)
-    eit-revgraph(1), eit-search(1), eit-status(1), eit-unlock(1), eit-vacuum(1)
+    eit-match(1), eit-merge(1), eit-mv(1), eit-notice(1), eit-own(1)
+    eit-pkgmove(1), eit-push(1), eit-query(1), eit-remove(1), eit-repack(1)
+    eit-repo(1), eit-reset(1), eit-revgraph(1), eit-search(1), eit-status(1)
+    eit-test(1), eit-unlock(1), eit-vacuum(1)
     

server/eit/commands/merge.py

@@ -52,6 +52,22 @@ class EitMerge(EitCommand):
 
         return parser
 
+    INTRODUCTION = """\
+When a repository is switched to a new branch, remote packages,
+for mirror size optimization reasons, are kept in current folders exposing
+the old branch as sub-directory and referenced from there until
+they get replaced into the repository. At some point in the future btw,
+older branches would be dismissed and packages in repository on the
+current branch referencing packages in older branches should be merged
+back in. This tool does exactly this.
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         """ Overridden from EitCommit """
         parser = self._get_parser()
@@ -77,5 +93,5 @@ EitCommandDescriptor.register(
     EitCommandDescriptor(
         EitMerge,
         EitMerge.NAME,
-        _('merge branch into current'))
+        _('merge packages on other branches into current'))
     )

server/eit/commands/pkgmove.py

@@ -49,6 +49,23 @@ class EitPkgmove(EitCommand):
 
         return parser
 
+    INTRODUCTION = """\
+Packages can be renamed or get their SLOT changed over time (say
+thanks to Source Package Managers like Portage :-/).
+To ensure that Entropy Clients do update their metadata accordingly,
+any change done server-side is recorded into the repository itself.
+This tool makes possible to edit such "raw" metadata.
+The risk of completely disrupting Entropy Clients (and distro installs)
+is very high, use this tool *only, and only if* you know what you're
+doing.
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def bashcomp(self, last_arg):
         """
         Overridden from EitCommand

server/eit/commands/push.py

@@ -110,6 +110,17 @@ class EitPush(EitCommand):
         sys.stdout.write(" ".join(outcome) + "\n")
         sys.stdout.flush()
 
+    INTRODUCTION = """\
+Synchronize remote mirrors with local repository content (packages and
+repository).
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         parser = self._get_parser()
         try:

server/eit/commands/query.py

@@ -127,6 +127,17 @@ class EitQuery(EitCommand):
 
         return parser
 
+    INTRODUCTION = """\
+Toolset containing all the Entropy Server built-in repository query
+tools.
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         """ Overridden from EitCommand """
         parser = self._get_parser()

server/eit/commands/remove.py

@@ -56,6 +56,17 @@ class EitRemove(EitCommand):
 
         return parser
 
+    INTRODUCTION = """\
+Remove a package from repository. It's no-brainer actually.
+"""
+    SEE_ALSO = "eit-add(1)"
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         parser = self._get_parser()
         try:

server/eit/commands/repo.py

@@ -39,6 +39,17 @@ class EitRepo(EitCommand):
             prog="%s %s" % (sys.argv[0], EitRepo.NAME))
         return parser
 
+    INTRODUCTION = """\
+Show current repository, its branch and configured mirrors.
+"""
+    SEE_ALSO = "eit-status(1)"
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         """ Overridden from EitCommand """
         parser = self._get_parser()

server/eit/commands/reset.py

@@ -86,6 +86,17 @@ class EitReset(EitPush):
         sys.stdout.write(" ".join(outcome) + "\n")
         sys.stdout.flush()
 
+    INTRODUCTION = """\
+Discard all the changes made to the local repository by completely
+re-fetching the remote version available on mirrors.
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         """ Overridden from EitPush """
         parser = self._get_parser()

server/eit/commands/test.py

@@ -90,6 +90,16 @@ class EitTest(EitCommand):
 
         return parser
 
+    INTRODUCTION = """\
+Toolset containing all the Entropy Server built-in QA tests available.
+"""
+
+    def man(self):
+        """
+        Overridden from EitCommand.
+        """
+        return self._man()
+
     def parse(self):
         """ Overridden from EitCommand """
         parser = self._get_parser()