Bug #85386

Fix inconsistency of command line arguments, help output and docs of sysext "lowlevel"

Added by Sybille Peters over 1 year ago. Updated over 1 year ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
-
Target version:
-
Start date:
2018-06-25
Due date:
% Done:

0%

TYPO3 Version:
8
PHP Version:
Tags:
Complexity:
easy
Is Regression:
Sprint Focus:

Description

Note: Closed for now, until researched further. Initially noticed that documentation partly does not fit behaviour or may be a little difficult to understand.

There seems to be also an issue with inconsistency of some options and the help output.

1. Some commands have --dry-run in their help message and some do not

  • cleanup:deletedrecords : does not
  • cleanup:multiplereferencedfiles : does

Weird that deletedrecords should suddenly not support dry-run

this needs to be researched further, not really a problem of the docs, though.

https://github.com/TYPO3/TYPO3.CMS/blob/TYPO3_8-7/typo3/sysext/lowlevel/README.rst

In TYPO3 7 there where some common options so you could execute the commands without problems in a loop using a generic commmand line, e.g.

for tag in $tags;do 
  if [[ $cmd == fix ]];then
    # fix
    php ./typo3/cli_dispatch.phpsh lowlevel_cleaner $tag -r -s -v 2 --AUTOFIX --YES --refindex update 
  else
    # dry-run
    php ./typo3/cli_dispatch.phpsh lowlevel_cleaner $tag -r -s -v 2 --dryrun  
  fi
done

Having --dryrun and --AUTOFIX makes absolutely no sense, so it is better now, but it should be easier to use.

2. Usage:

  help [options] [--] [<command_name>]

Arguments:
  command               The command to execute
  command_name          The command name [default: "help"]

Not very inuitive

  • where is 'command' in the usage at the top?

3. Two different help messages with help and --help.

The output with --help is confusing (--help is documented), the output of help is better. Maybe better to document only help (and not --help and remove that)

e.g

php ./typo3/sysext/core/bin/typo3 help cleanup:multiplereferencedfiles

History

#1 Updated by Sybille Peters over 1 year ago

  • Status changed from New to Closed

#2 Updated by Sybille Peters over 1 year ago

  • Description updated (diff)
  • Complexity changed from no-brainer to easy

#3 Updated by Sybille Peters over 1 year ago

  • Subject changed from Fix documentation of sysext "lowlevel" to Fix inconsistency of command line arguments, help output and docs of sysext "lowlevel"
  • Description updated (diff)
  • Category deleted (Documentation)

#4 Updated by Sybille Peters over 1 year ago

  • Description updated (diff)

Also available in: Atom PDF