Skip to content

Commit ecb6679

Browse files
authored
Merge pull request #61945 from nextcloud/backport/61657/stable34
[stable34] chore(jobs): write proper documentation for job:history
2 parents 0513544 + 4e58812 commit ecb6679

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

core/Command/Background/JobsHistory.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ protected function configure(): void {
3333
parent::configure();
3434

3535
$help = <<<EOF
36-
Display all currently running background jobs.
36+
List historical job executions
3737
38-
You can find the following informations:
38+
The output includes:
3939
- <info>Run ID:</info> job identifier as found in database (Snowflake ID)
40+
- <info>Status:</info> result of the job (Succeeded, Failed, Crashed)
4041
- <info>Class:</info> class of the job
4142
- <info>Started at:</info> start time of the job
4243
- <info>Server ID:</info> server ID as defined in <options=bold>config.php</> (see `serverid`). Highlighted if it’s running on current server.
@@ -48,7 +49,7 @@ protected function configure(): void {
4849

4950
$this
5051
->setName('background-job:history')
51-
->setDescription('Show currently running jobs')
52+
->setDescription('List historical job executions')
5253
->setHelp($help)
5354
->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Maximum number of results returned by the command', 200)
5455
->addOption('class', 'c', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Filter by class name', [])

core/Command/Background/RunningJobs.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ protected function configure(): void {
3232
$help = <<<EOF
3333
Display all currently running background jobs.
3434
35-
You can find the following informations:
35+
The output includes:
3636
- <info>Run ID:</info> job identifier a found in database (Snowflake ID)
3737
- <info>Class:</info> class of the job
3838
- <info>Started at:</info> start time of the job

0 commit comments

Comments
 (0)