particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

minor docs cleanup

Browse source
This commit is contained in:
Mike McLean 2017-08-03 11:33:04 -04:00
parent 83e47bf42a
commit fcdd342a1d
2 changed files with 18 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/external_repo_server_bootstrap.rst
View file

@ -11,7 +11,7 @@ hub is up, appropriate authentication methods have been configured, the Koji
repo administration daemon (``kojira``) is properly configured and running,
and at least one Koji builder (``kojid``) is properly configured and running.
All koji cli commands assume that the user is a Koji ``admin``. If you need
help with these tasks, see the :doc:`ServerHowTo <server_howto>`.
help with these tasks, see the :doc:`server_howto`.
* Create a new tag. ::

29
docs/source/writing_a_plugin.rst
View file

@ -211,18 +211,23 @@ Most simple command would look like this:
(opts, args) = parser.parse_args(args)
print(args[0])
`@export_cli` is decorator which will register plugin's command with name
derived from name of the function. Function name needs to follow one rule: It
has to start with `anon_handle_` or `handle_`. Rest of the name is name of
the command. First one will not authenticate against hub (user can still override
this behaviour with `--force-auth` or `--mine` options where it is relevant)
- it is simply same as using `--noath` option. Second variant doesn't presume
anything about authentication.
`@export_cli` is a decorator which registers a new command. The command
name is derived from name of the function. The function name must start with
either `anon_handle_` or `handle_`. The rest of the name becomes the name of
the command.
Compared to this simple example is real usage with API calls. Koji provides
some important functions via client library `koji_cli.lib` which can be
imported and used inside command's function. Feel free to examine, what is
provided there. Some notable examples are:
In the first case, the command will not automatically
authenticate with the hub (though the user can still override
this behaviour with `--force-auth` option). In the second case, the command
will perform authentication by default (this too can be overridden by the
user with the `--noauth` option).
The example above is very simplistic. We recommend that developers also
examine the actual calls included in Koji. The built in commands live in
`koji_cli.commands` and our standard cli plugins live in `plugins/cli`.
Koji provides some important functions via in the client cli library
(`koji_cli.lib`) for use by cli commands. Some notable examples are:
* `activate_session(session, options)` - It is needed to authenticate
against hub. Both parameters are same as those passed to handler.
@ -242,7 +247,7 @@ CLI plugins structure will be extended (made configurable and allowing more
than just adding commands - e.g. own authentication methods, etc.) in future.
Pull requests
^^^^^^^^^^^^^
=============
These plugins have to be written in python 2.6+/3.x compatible way. We are
using `six` library to support this, so we will also prefer pull requests