Skip to content

Commit

Permalink
docs/usage.rst: Updates example how to list registered jobs
Browse files Browse the repository at this point in the history
Co-authored-by: Frank Sachsenheim <[email protected]>
  • Loading branch information
M3ssman and funkyfuture committed Oct 16, 2024
1 parent 2f48370 commit 85a1da6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ both ``stdout`` (``>``) and ``stderr`` (``2>``) separately as shown.
Listing all registered jobs
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Information, including the next scheduled execution, about the registered jobs of a deck-chores
instance can be logged at once by sending ``SIGUSR1`` signal to the process, e.g. to one that runs
in a container::
Information about the registered jobs, including the next scheduled execution,
of a *deck-chores* instance can be logged by sending ``SIGUSR1`` signal to the
*deck-chores* process. For example, when invoked as a ``docker compose``
project, one needs to call::

docker kill --signal USR1 <CONTAINER>
docker kill --signal USR1 deck-chores_officer_1


The output appears in ``deck-chores``' log target, that are the container's logs when it runs within
one.
The output appears in *deck-chores*' log target, that are the container's logs
when it runs within one.


Job definitions
Expand Down

0 comments on commit 85a1da6

Please sign in to comment.