[elbe-devel] [PATCH] Add manpage for `elbe prjrepo` commands and cleanup prjrepo

[Manuel Traut]

Just a few comments, ..

On Thu, May 11, 2017 at 02:39:11PM +0200, Philipp Arras wrote:
> Signed-off-by: Philipp Arras <philipp.arras at linutronix.de>
> ---
>  docs/elbe-prjrepo.txt        | 73 ++++++++++++++++++++++++++++++++++++++++++++
>  elbepack/commands/prjrepo.py | 11 -------
>  2 files changed, 73 insertions(+), 11 deletions(-)
>  create mode 100644 docs/elbe-prjrepo.txt
> 
> diff --git a/docs/elbe-prjrepo.txt b/docs/elbe-prjrepo.txt
> new file mode 100644
> index 0000000..23e3939
> --- /dev/null
> +++ b/docs/elbe-prjrepo.txt
> @@ -0,0 +1,73 @@
> +elbe-prjrepo(1)
> +===============
> +
> +NAME
> +----
> +elbe-prjrepo - High Level Interface to the ELBE System.

the high level Interface is 'initvm' please just drop this comment and replace
it with the following:

> +               Provides access to the Debian repositories in each project folder.
> +
> +
> +SYNOPSIS
> +--------
> +[verse]
> +'elbe prjrepo download' <project_dir>
> +'elbe prjrepo upload_pkg' <project_dir> [<debfile> | <dscfile>]
> +'elbe prjrepo list_packages' <project_dir>
> +
> +DESCRIPTION
> +-----------
> +
> +Whenever Elbe builds a new project (e.g. when running `elbe initvm submit
> +<xml_file>`) it creates a local Debian repository from which it installs the
> +Debian packages

only the packages that were generated by pbuilder are in this repo. Not all
Debian packages.

> +into the respective root file system.
> +
> +OPTIONS
> +-------
> +
> +--user <username>::
> +	Username to use for login (defaults to root).
> +
> +--pass <password>::
> +	Password for login (defaults to 'foo').
> +
> +--retries <N>::
> +	How many times to retry the connection to the server before giving up
> +	(default is 10 times, yielding 10 seconds).
> +
> +COMMANDS
> +--------
> +
> +'download' <project_dir>::
> +
> +Downloads the Debian repository of the project located in <project_dir> to the
> +host machine.
> +
> +
> +'upload_pkg' <project_dir> [<debfile> | <dscfile>]::
> +
> +Loads a Debian package into the Debian repository of an existing Elbe project in
> +the initvm. Both binary and source packages are supported. In order to upload a
> +source package you need to specify the dsc-file in the command as shown above.
> +The actual source files which are required for the source package need to be
> +located in the same directory as the dsc-file.
> +
> +
> +'list_packages' <project_dir>::
> +
> +Lists all packages available in the Debian repository of the project.
> +
> +
> +Example
> +-------
> +
> +* List the packages available in the project 38599ce2-4cad-4578-bfe1-06fa793b883a:
> ++
> +------------
> +$ elbe prjrepo list_packages "/var/cache/elbe/38599ce2-4cad-4578-bfe1-06fa793b883a"
> +------------
> +
> +
> +
> +ELBE
> +----
> +Part of the linkgit:elbe[1] suite

the following is IMHO worth a seperate patch

> diff --git a/elbepack/commands/prjrepo.py b/elbepack/commands/prjrepo.py
> index 515ce5b..eb8497f 100755
> --- a/elbepack/commands/prjrepo.py
> +++ b/elbepack/commands/prjrepo.py
> @@ -38,9 +38,6 @@ from elbepack.elbexml import ValidationMode
>  def run_command(argv):
>      oparser = OptionParser(usage="usage: elbe prjrepo [options] <command>")
>  
> -    oparser.add_option("--project", dest="project", default=None,
> -                       help="project directory on the initvm")
> -
>      oparser.add_option("--host", dest="host", default="localhost",
>                         help="Ip or hostname of elbe-daemon.")
>  
> @@ -60,18 +57,10 @@ def run_command(argv):
>          help="How many times to retry the connection to the server before\
>                  giving up (default is 10 times, yielding 10 seconds).")
>  
> -    oparser.add_option("--output",
> -                       dest="output", default=None,
> -                       help="Output files to <directory>")
> -
>      devel = OptionGroup(
>          oparser,
>          "options for elbe developers",
>          "Caution: Don't use these options in a productive environment")
> -    devel.add_option("--skip-urlcheck", action="store_true",
> -                     dest="url_validation", default=ValidationMode.CHECK_ALL,
> -                     help="Skip URL Check inside initvm")
> -
>      devel.add_option("--debug", action="store_true",
>                       dest="debug", default=False,
>                       help="Enable debug mode.")
> -- 
> 2.1.4
> 
> 
> _______________________________________________
> elbe-devel mailing list
> elbe-devel at linutronix.de
> https://lists.linutronix.de/mailman/listinfo/elbe-devel