[elbe-devel] [PATCH] docs: update man pages to match with current commands
Manuel Traut
manut at linutronix.de
Mon Jul 3 15:04:03 CEST 2017
From: Philipp Arras <philipp.arras at linutronix.de>
this updates the man pages to be in sync with the current
elbe commands.
Signed-off-by: Philipp Arras <philipp.arras at linutronix.de>
---
docs/elbe-control.txt | 22 ++++++++-
docs/elbe-daemon.txt | 35 ++++++++++++++
docs/elbe-db.txt | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++
docs/elbe-initvm.txt | 6 +++
elbepack/dbaction.py | 2 +-
5 files changed, 192 insertions(+), 3 deletions(-)
create mode 100644 docs/elbe-daemon.txt
create mode 100644 docs/elbe-db.txt
diff --git a/docs/elbe-control.txt b/docs/elbe-control.txt
index d902bead..b1aada00 100644
--- a/docs/elbe-control.txt
+++ b/docs/elbe-control.txt
@@ -14,6 +14,8 @@ SYNOPSIS
'elbe control' [options] 'build_sysroot' <build-dir>
'elbe control' [options] 'set_pdebuild' <project-dir> <pdebuild file>
'elbe control' [options] 'get_files' <build-dir>
+'elbe control' [options] 'build_chroot_tarball' <build-dir>
+'elbe control' [options] 'set_orig' <build-dir>
'elbe control' [options] 'set_cdrom' <build-dir> <iso-img>
'elbe control' [options] 'reset_project' <build-dir>
'elbe control' [options] 'list_users'
@@ -58,8 +60,8 @@ OPTIONS
--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).
+--retries <N>:: How many times to retry the connection to the server before
+ giving up (default is 10 times, yielding 10 seconds).
--build-bin::
Build binary repository CDROM, for exact reproduction.
@@ -70,6 +72,9 @@ OPTIONS
--output <directory>::
Output downloaded files to <directory>.
+--pbuilder-only::
+ Only list/download pbuilder files.
+
COMMANDS
--------
@@ -113,6 +118,19 @@ If the --output option is specified, the files are downloaded to
the directory specified in the option.
+'build_chroot_tarball' <build-dir>::
+
+Creates a tarball of the chroot environment in <build_dir>.
+
+
+'set_orig' <build-dir> <orig-file>::
+
+Uploads a quilt orig-file to the initvm.
++
+This command shall be run before building a Debian package with `elbe pbuilder
+build` if the package is given in the quilt source format.
+
+
'set_cdrom' <build-dir> <iso-img>::
Set the cdrom iso image. The <iso-img> is uploaded into the intivm.
diff --git a/docs/elbe-daemon.txt b/docs/elbe-daemon.txt
new file mode 100644
index 00000000..e9f1f569
--- /dev/null
+++ b/docs/elbe-daemon.txt
@@ -0,0 +1,35 @@
+elbe-daemon(1)
+================
+
+NAME
+----
+elbe-daemon - control the ELBE daemon.
+
+SYNOPSIS
+--------
+[verse]
+'elbe daemon' [options]
+
+
+DESCRIPTION
+-----------
+This command controls the ELBE daemon and is run inside the inivm.
+
+
+OPTIONS
+-------
+--host <hostname>::
+ ip or hostname of the elbe-deamon (defaults to localhost, which
+ is the default, where an initvm would be listening).
+
+--port <N>::
+ Port of the soap interface on the elbe-daemon.
+
+--<daemon>::
+ Enable <daemon>.
+
+
+
+ELBE
+----
+Part of the linkgit:elbe[1] suite
diff --git a/docs/elbe-db.txt b/docs/elbe-db.txt
new file mode 100644
index 00000000..2c59f60b
--- /dev/null
+++ b/docs/elbe-db.txt
@@ -0,0 +1,130 @@
+elbe-db(1)
+================
+
+NAME
+----
+elbe-db - interface to the ELBE db. Must be run inside the initvm.
+
+SYNOPSIS
+--------
+[verse]
+'elbe db' [options] 'list_projects'
+'elbe db' [options] 'create_project' <project_dir>
+'elbe db' [options] 'get_files' <project_dir>
+'elbe db' [options] 'reset_project' <project_dir>
+'elbe db' [options] 'list_users'
+'elbe db' [options] 'save_version' <project_dir>
+'elbe db' [options] 'set_xml' <project_dir> <xml_file>
+'elbe db' [options] 'del_project' <project_dir>
+'elbe db' [options] 'print_version_xml' <project_dir> <version>
+'elbe db' [options] 'init'
+'elbe db' [options] 'del_user' <userid>
+'elbe db' [options] 'set_project_version' <project_dir> <version>
+'elbe db' [options] 'add_user' <username>
+'elbe db' [options] 'list_versions' <project_dir>
+'elbe db' [options] 'del_versions' <project_dir> <version>
+'elbe db' [options] 'build' <project_dir>
+
+
+DESCRIPTION
+-----------
+This command controls the ELBE daemon and is run inside the initvm.
+
+
+OPTIONS
+-------
+-h, --help::
+ Displays help.
+
+--name::
+ Sets the name of the new user.
+
+--fullname::
+ Sets the full name of the new user.
+
+--password::
+ Sets the password of the new user.
+
+--email::
+ Sets the email address of the new user.
+
+--noadmin:: TODO!! MACHT MEINER MEINUNG NACH DAS GLEICHE WIE ADMIN.
+
+--admin::
+ Gives the new user admin privileges. (Boolean variable, default=False).
+
+--delete-projects::
+ Delete all projects owned by the user.
+
+--quiet::
+ TODO
+
+--user::
+ User name of the project owner.
+
+--clean::
+ Deletes the target and chroot directory in <project-dir>.
+
+--description::
+ Description of the project version which shall be stored in the database.
+
+
+COMMANDS
+--------
+'init'::
+ Creates a new ELBE database and adds one new user. Options: name[=root],
+ fullname[=Admin], password[=foo], email[=root at localhost], noadmin[=True].
+
+'add_user' <username>::
+ Adds a new user. Options: fullname, password, email, admin=[False].
+
+'del_user' <userid>::
+ Deletes user <userid>. Options: delete-projects[=False], quiet=[False].
+
+'list_projects'::
+ Lists all projects stored in the database.
+
+'list_users'::
+ Lists all users registered in the ELBE database.
+
+'create_project' <project_dir>::
+ Creates a new project in directory <project_dir>. Options: user.
+
+'del_project' <project_dir>::
+ Removes project in <project_dir> from ELBE database.
+
+'set_xml' <project_dir> <xml_file>::
+ Assigns the file <xml_file> as ELBE recipe to the project in <project_dir>.
+
+'build' <project_dir>::
+ Builds the project in <project_dir>.
+
+'get_files' <project_dir>::
+ Returns a list of all files and directories in <project_dir>
+
+'reset_project' <project_dir>::
+ Resets the project state in the database. Can be useful if a build has been
+ aborted and the project is set `busy` in in the database obstructing future
+ actions on this project. Options: clean[=False].
+
+'set_project_version' <project_dir> <version>::
+ Sets the project version of project <project_dir> to <version>.
+
+'list_versions' <project_dir>::
+ Lists all versions of project <project_dir>.
+
+'save_version' <project_dir>::
+ Saves current state of project <project_dir> as version. Options: description.
+
+'del_versions' <project_dir> <version>::
+ Deletes the version <version> of project <project_dir>.
+
+'print_version_xml' <project_dir> <version>::
+ Prints ELBE xml file in <project_dir> of version <version>.
+
+
+
+
+ELBE
+----
+Part of the linkgit:elbe[1] suite
diff --git a/docs/elbe-initvm.txt b/docs/elbe-initvm.txt
index a4a28023..f44c0727 100644
--- a/docs/elbe-initvm.txt
+++ b/docs/elbe-initvm.txt
@@ -14,6 +14,7 @@ SYNOPSIS
'elbe initvm' [options] 'create' [<xmlfile> | <isoimage>]
'elbe initvm' [options] 'submit' [<xmlfile> | <isoimage>]
'elbe initvm' [options] 'start'
+'elbe initvm' [options] 'stop'
'elbe initvm' [options] 'ensure'
'elbe initvm' [options] 'start_build'
@@ -103,6 +104,11 @@ be used, and all the binary packages available also.
Start initvm in the Background.
+'stop'::
+
+Shutdown running initvm.
+
+
'ensure'::
Make sure an initvm is running in the Background.
diff --git a/elbepack/dbaction.py b/elbepack/dbaction.py
index fe147007..92515c17 100644
--- a/elbepack/dbaction.py
+++ b/elbepack/dbaction.py
@@ -75,7 +75,7 @@ class AddUserAction(DbAction):
DbAction.__init__(self, node)
def execute(self, args):
- oparser = OptionParser (usage="usage: %prog db add_user [options] username")
+ oparser = OptionParser (usage="usage: %prog db add_user [options] <username>")
oparser.add_option ("--fullname", dest="fullname")
oparser.add_option ("--password", dest="password")
oparser.add_option ("--email", dest="email")
--
2.13.2
More information about the elbe-devel
mailing list