Project

General

Profile

Actions

Bug #59843

closed

Fix the help message of CLI

Added by Stefano Kowalke almost 10 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Should have
Category:
-
Target version:
Start date:
2014-06-24
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
6.2
PHP Version:
5.4
Tags:
Complexity:
no-brainer
Is Regression:
No
Sprint Focus:

Description

The CLI offers a help which prints the informations of a command

./cli_dispatch.phpsh extbase extensionapi:fetch help
Fetch an extension from TER.

COMMAND:
  core_a_p_i:extensionapi:fetch

USAGE:
  /Volumes/HDD/Users/sok/Sites/TYPO3/www.coreapi.dev/http/./typo3cms ./typo3cms extensionapi:fetch [<options>] <key>

ARGUMENTS:
  --key                The extension key

OPTIONS:
  --version            The exact version of the extension, otherwise the latest
                       will be picked
  --location           Where to put the extension. System = typo3/sysext,
                       Global = typo3/ext, Local = typo3conf/ext
  --overwrite          $overwrite Overwrite the extension if already exists
  --mirror             $mirror    Mirror to fetch the extension from. Run
                       extensionapi:listmirrors to get the list of all
                       available repositories, otherwise a random mirror will
                       be selected

The text will be extracted by Reflection from the doc header of the method.

/**
 * Fetch an extension from TER.
 *
 * @param string $key       The extension key
 * @param string $version   The exact version of the extension, otherwise the latest will be picked
 * @param string $location  Where to put the extension. System = typo3/sysext, Global = typo3/ext, Local = typo3conf/ext
 * @param bool   $overwrite Overwrite the extension if already exists
 * @param int    $mirror    Mirror to fetch the extension from. Run extensionapi:listmirrors to get the list of all available repositories, otherwise a random mirror will be selected
 *
 * @return void
 */

As you can see the help text includes sometimes the name of the variable ($override, $mirror). This happens when there are more than one whitespaces between the datatype and the variable, which is needed to align the header comment.

Actions

Also available in: Atom PDF