Mercurial > kallithea
comparison docs/usage/general.rst @ 6554:2c3d30095d5e
gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack
This is a step towards moving away from the Pylons stack to TurboGears2, but
still independent of it.
Some notes from the porting - it could perhaps be the missing(?) documentation
for migrating from paster to gearbox:
Note: 'gearbox' without parameters will crash - specify '-h' to get started
testing.
Replace paster
summary = 'yada yada'
with the first line of the docstring of the Command class ... or override
get_description.
Note: All newlines in the docstring will be collapsed and mangle the long help
text.
Grouping of commands is not possible. Standard commands (for development) can't
be customized under the same name or hidden. (Like for paster, the conceptual
model also assumes that the sub-command naming is namespaced so commands from
other packages won't conflict.)
The usage help is fully automated from the declared options.
For all deprecated Commands, replace paster
hidden = True
with gearbox
deprecated = True
Note: config_file, takes_config_file, min_args and max_args are not available /
relevant.
The gearbox parser is customized by overriding get_parser - there is nothing
like paster update_parser.
Gearbox is using argparse instead of optparse ... but argparse add_argument is
mostly backwards compatible with optparse add_option.
Instead of overriding command or run as in paster, override take_action in
gearbox. The parsed arguments are passed to take_action, not available on the
command instance.
Paster BadCommand is not available and must be handled manually, terminating
with sys.exit(1).
There is no standard make-config command in gearbox.
Paster appinstall has been replaced by the somewhat different setup_app module
in gearbox. There is still no clean way to pass parameters to SetupAppCommand
and it relies on websetup and other apparently unnecessary complexity. Instead,
implement setup-db from scratch.
Minor change by Thomas De Schampheleire: add gearbox logging configuration.
Because we use logging.config.fileConfig(.inifile) during gearbox command
execution, the logging settings need to be correct and contain a block for
gearbox logging itself. Otherwise, errors in command processing are not even
visible and the command exits silently.
author | Mads Kiilerich <madski@unity3d.com> |
---|---|
date | Tue, 25 Oct 2016 21:32:24 +0200 |
parents | ed2fb6e84a02 |
children | 977e7aca38b1 |
comparison
equal
deleted
inserted
replaced
6553:e9ac5698281d | 6554:2c3d30095d5e |
---|---|
13 renames it in a special way so that it is not possible to push, clone | 13 renames it in a special way so that it is not possible to push, clone |
14 or access the repository. | 14 or access the repository. |
15 | 15 |
16 There is a special command for cleaning up such archived repositories:: | 16 There is a special command for cleaning up such archived repositories:: |
17 | 17 |
18 paster cleanup-repos --older-than=30d my.ini | 18 gearbox cleanup-repos --older-than=30d -c my.ini |
19 | 19 |
20 This command scans for archived repositories that are older than | 20 This command scans for archived repositories that are older than |
21 30 days, displays them, and asks if you want to delete them (unless given | 21 30 days, displays them, and asks if you want to delete them (unless given |
22 the ``--dont-ask`` flag). If you host a large amount of repositories with | 22 the ``--dont-ask`` flag). If you host a large amount of repositories with |
23 forks that are constantly being deleted, it is recommended that you run this | 23 forks that are constantly being deleted, it is recommended that you run this |