From dab61cc85187f40bd897ba274e0507ac3efbac0a Mon Sep 17 00:00:00 2001
From: Sybille Peters <sypets@gmx.de>
Date: Sun, 16 Feb 2020 12:35:25 +0100
Subject: [PATCH] [DOCS] Document multiple --task options for scheduler
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Document change "Feature: #87451 - scheduler:run command accepts
multiple task options".

The scheduler command now accepts multiple --task options.

Resolves: #90394
Releases: master
Change-Id: Ie0f7973cab01db88f4df0cb4cd87a194bf4914b1
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63270
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
---
 .../SchedulerShellScript/Index.rst            | 80 ++++++++++++++-----
 1 file changed, 58 insertions(+), 22 deletions(-)

diff --git a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst
index 25abcfb2d67a..74d5f0fe2353 100644
--- a/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst
+++ b/typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst
@@ -9,49 +9,85 @@
 
 .. _scheduler-shell-script:
 
-The Scheduler shell script
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==========================
+The scheduler shell script
+==========================
 
-The Scheduler provides a PHP shell script designed to be run using
+The scheduler provides a PHP shell script designed to be run using
 TYPO3's command-line dispatcher. To try and run that script a first
-time, type the following command (adapting the path to TYPO3
-to match your system and add the full path to the php interpreter
-in front of the command if php is not on the search path):
+time, type the following command.
 
-::
+On a Composer based system::
 
-   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
-   /usr/local/bin/php /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
+   bin/typo3 scheduler:run
 
-If your installation is a composer based instance you can use this command line
-in your installation directory:
 
-::
+On a system without Composer (adapt the path to TYPO3
+to match your system)::
+
+   typo3/sysext/core/bin/typo3 scheduler:run
+
+You might have to add the full path to the PHP interpreter
+in front of the command if PHP is not on the search path::
+
+   /usr/local/bin/php typo3/sysext/core/bin/typo3 scheduler:run
 
-   bin/typo3 scheduler:run
-   /usr/local/bin/php bin/typo3 scheduler:run
 
+In the following examples, we will use the path to `typo3` for systems
+with Composer.
 
-.. _options:
+Show help
+=========
+
+In order to show help::
+
+   bin/typo3 scheduler:run --help
+
+
+.. _scheduler-shell-script-options:
 
 Providing options to the shell script
-"""""""""""""""""""""""""""""""""""""
+=====================================
 
 The shell scripts accepts a number of options which can be provided in any
 order.
 
-To run a specific scheduler task you need to provide the uid of the task:
+`--task (-i)`
+-------------
+
+To run a specific scheduler task you need to provide the uid of the task::
 
-::
+   bin/typo3 scheduler:run --task=8
+
+or
+
+   bin/typo3 scheduler:run -i 8
 
-   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=8
 
 The example will trigger the task with uid 8.
 
-To run a task even if it is disabled, you need to provide the force option
+.. versionadded:: 10.3
+
+    It is possible to run several tasks::
+
+        bin/typo3 scheduler:run --task=8 --task=2
+
+    The tasks will be executed in the order in which they are provided.
 
-::
+`--f`
+-----
 
-   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=8 -f
+To run a task even if it is disabled (or not scheduled to be run yet),
+you need to provide the force option::
+
+   bin/typo3 scheduler:run --task=8 -f
 
 This will also run the task with uid 8 if it is disabled.
+
+`--v`
+-----
+
+A single -v flag will output errors only. Two -vv flags will also output additional
+information::
+
+    bin/typo3 scheduler:run --task=8 -v
-- 
GitLab