From 71d9dd51ae7e53fb2257e30b34c54fa699a304aa Mon Sep 17 00:00:00 2001 From: Evgeniy Alekseev Date: Sun, 13 Aug 2023 15:44:51 +0300 Subject: [PATCH] docs update --- docs/ahriman.core.report.rst | 8 +++++++ docs/ahriman.models.rst | 8 +++++++ docs/ahriman.web.schemas.rst | 24 +++++++++++++++++++ docs/ahriman.web.views.service.rst | 8 +++++++ docs/configuration.rst | 11 +++++++++ .../bash-completion/completions/_ahriman | 2 +- package/share/man/man1/ahriman.1 | 9 +++++-- package/share/zsh/site-functions/_ahriman | 1 + 8 files changed, 68 insertions(+), 3 deletions(-) diff --git a/docs/ahriman.core.report.rst b/docs/ahriman.core.report.rst index 65d5bb9a..4738814d 100644 --- a/docs/ahriman.core.report.rst +++ b/docs/ahriman.core.report.rst @@ -36,6 +36,14 @@ ahriman.core.report.jinja\_template module :no-undoc-members: :show-inheritance: +ahriman.core.report.remote\_call module +--------------------------------------- + +.. automodule:: ahriman.core.report.remote_call + :members: + :no-undoc-members: + :show-inheritance: + ahriman.core.report.report module --------------------------------- diff --git a/docs/ahriman.models.rst b/docs/ahriman.models.rst index e4799fa5..253e2e45 100644 --- a/docs/ahriman.models.rst +++ b/docs/ahriman.models.rst @@ -220,6 +220,14 @@ ahriman.models.user\_access module :no-undoc-members: :show-inheritance: +ahriman.models.waiter module +---------------------------- + +.. automodule:: ahriman.models.waiter + :members: + :no-undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/ahriman.web.schemas.rst b/docs/ahriman.web.schemas.rst index 923bc1c9..aa8d422a 100644 --- a/docs/ahriman.web.schemas.rst +++ b/docs/ahriman.web.schemas.rst @@ -132,6 +132,22 @@ ahriman.web.schemas.pgp\_key\_schema module :no-undoc-members: :show-inheritance: +ahriman.web.schemas.process\_id\_schema module +---------------------------------------------- + +.. automodule:: ahriman.web.schemas.process_id_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.process\_schema module +------------------------------------------ + +.. automodule:: ahriman.web.schemas.process_schema + :members: + :no-undoc-members: + :show-inheritance: + ahriman.web.schemas.remote\_schema module ----------------------------------------- @@ -156,6 +172,14 @@ ahriman.web.schemas.status\_schema module :no-undoc-members: :show-inheritance: +ahriman.web.schemas.update\_flags\_schema module +------------------------------------------------ + +.. automodule:: ahriman.web.schemas.update_flags_schema + :members: + :no-undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/ahriman.web.views.service.rst b/docs/ahriman.web.views.service.rst index e1911b80..e2e6fa20 100644 --- a/docs/ahriman.web.views.service.rst +++ b/docs/ahriman.web.views.service.rst @@ -20,6 +20,14 @@ ahriman.web.views.service.pgp module :no-undoc-members: :show-inheritance: +ahriman.web.views.service.process module +---------------------------------------- + +.. automodule:: ahriman.web.views.service.process + :members: + :no-undoc-members: + :show-inheritance: + ahriman.web.views.service.rebuild module ---------------------------------------- diff --git a/docs/configuration.rst b/docs/configuration.rst index acd51c61..6de7e245 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -247,6 +247,17 @@ Section name must be either ``html`` (plus optional architecture name, e.g. ``ht * ``path`` - path to html report file, string, required. * ``template_path`` - path to Jinja2 template, string, required. +``remote-call`` type +^^^^^^^^^^^^^^^^^^^^ + +Section name must be either ``remote-call`` (plus optional architecture name, e.g. ``remote-call:x86_64``) or random name with ``type`` set. + +* ``type`` - type of the report, string, optional, must be set to ``remote-call`` if exists. +* ``aur`` - check for AUR packages updates, boolean, optional, default ``no``. +* ``local`` - check for local packages updates, boolean, optional, default ``no``. +* ``manual`` - update manually built packages, boolean, optional, default ``no``. +* ``wait_timeout`` - maximum amount of time in seconds to be waited before remote process will be terminated, int, optional, default ``-1``. + ``telegram`` type ^^^^^^^^^^^^^^^^^ diff --git a/package/share/bash-completion/completions/_ahriman b/package/share/bash-completion/completions/_ahriman index a536cfc2..90ffec35 100644 --- a/package/share/bash-completion/completions/_ahriman +++ b/package/share/bash-completion/completions/_ahriman @@ -2,7 +2,7 @@ _shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web') -_shtab_ahriman_option_strings=('-h' '--help' '-a' '--architecture' '-c' '--configuration' '--force' '-l' '--lock' '--log-handler' '--report' '--no-report' '-q' '--quiet' '--unsafe' '-V' '--version') +_shtab_ahriman_option_strings=('-h' '--help' '-a' '--architecture' '-c' '--configuration' '--force' '-l' '--lock' '--log-handler' '--report' '--no-report' '-q' '--quiet' '--unsafe' '--wait-timeout' '-V' '--version') _shtab_ahriman_aur_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by') _shtab_ahriman_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by') _shtab_ahriman_help_option_strings=('-h' '--help') diff --git a/package/share/man/man1/ahriman.1 b/package/share/man/man1/ahriman.1 index c2cf2629..17237ea5 100644 --- a/package/share/man/man1/ahriman.1 +++ b/package/share/man/man1/ahriman.1 @@ -1,9 +1,9 @@ -.TH AHRIMAN "1" "2023\-08\-07" "ahriman" "Generated Python Manual" +.TH AHRIMAN "1" "2023\-08\-13" "ahriman" "Generated Python Manual" .SH NAME ahriman .SH SYNOPSIS .B ahriman -[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--log-handler {console,syslog,journald}] [--report | --no-report] [-q] [--unsafe] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-create-keyring,repo-create-mirrorlist,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,user-add,user-list,user-remove,web} ... +[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--log-handler {console,syslog,journald}] [--report | --no-report] [-q] [--unsafe] [--wait-timeout WAIT_TIMEOUT] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-create-keyring,repo-create-mirrorlist,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,user-add,user-list,user-remove,web} ... .SH DESCRIPTION ArcH linux ReposItory MANager @@ -40,6 +40,11 @@ force disable any logging \fB\-\-unsafe\fR allow to run ahriman as non\-ahriman user. Some actions might be unavailable +.TP +\fB\-\-wait\-timeout\fR \fI\,WAIT_TIMEOUT\/\fR +wait for lock to be free. Negative value will lead to immediate application run even if there is lock file. In case of +zero value, tthe application will wait infinitely + .TP \fB\-V\fR, \fB\-\-version\fR show program's version number and exit diff --git a/package/share/zsh/site-functions/_ahriman b/package/share/zsh/site-functions/_ahriman index ddd6e9a2..eb431d40 100644 --- a/package/share/zsh/site-functions/_ahriman +++ b/package/share/zsh/site-functions/_ahriman @@ -85,6 +85,7 @@ _shtab_ahriman_options=( {--report,--no-report}"[force enable or disable reporting to web service (default\: True)]:report:" {-q,--quiet}"[force disable any logging (default\: False)]" "--unsafe[allow to run ahriman as non-ahriman user. Some actions might be unavailable (default\: False)]" + "--wait-timeout[wait for lock to be free. Negative value will lead to immediate application run even if there is lock file. In case of zero value, tthe application will wait infinitely (default\: -1)]:wait_timeout:" "(- : *)"{-V,--version}"[show program\'s version number and exit]" )