Bug #88874

TYPO3-CMS/lowlevel Missleading behavior and documentation

Added by Tobias Gaertner 16 days ago. Updated 16 days ago.

Status:
New
Priority:
Should have
Assignee:
-
Category:
CLI
Target version:
-
Start date:
2019-08-01
Due date:
% Done:

0%

TYPO3 Version:
9
PHP Version:
Tags:
Complexity:
Is Regression:
Sprint Focus:

Description

Part from the docs:

Example script for checking your installation

#!/bin/sh
./typo3/sysext/core/bin/typo3 cleanup:orphanrecords -vv
./typo3/sysext/core/bin/typo3 cleanup:versions -vv
./typo3/sysext/core/bin/typo3 cleanup:multiplereferencedfiles -vv
./typo3/sysext/core/bin/typo3 cleanup:deletedrecords -v
./typo3/sysext/core/bin/typo3 cleanup:missingrelations -vv
./typo3/sysext/core/bin/typo3 cleanup:flexforms -vv
./typo3/sysext/core/bin/typo3 cleanup:missingfiles -vv
./typo3/sysext/core/bin/typo3 cleanup:lostfiles -vv

Example script for cleaning your installation

#!/bin/sh
./typo3/sysext/core/bin/typo3 cleanup:orphanrecords -vv
./typo3/sysext/core/bin/typo3 cleanup:versions -vv
./typo3/sysext/core/bin/typo3 cleanup:multiplereferencedfiles -vv  --update-refindex
./typo3/sysext/core/bin/typo3 cleanup:deletedrecords -v
./typo3/sysext/core/bin/typo3 cleanup:missingrelations -vv  --update-refindex
./typo3/sysext/core/bin/typo3 cleanup:flexforms -vv
./typo3/sysext/core/bin/typo3 cleanup:missingfiles --update-refindex
./typo3/sysext/core/bin/typo3 cleanup:lostfiles -vv  --update-refindex

These two are identical. And so is the script part under "Nightly reports of problems in the system".

  • Nightly reports of problems in the system
    - add the "--dry-run" parameter to all calls
    - do something with the output. e,g, pipe it into a log-file (otherwise the whole block is senseless)
  • Example script for checking your installation
    - add the "--dry-run" parameter to all calls
  • Example script for cleaning your installation
    - the command "./typo3/sysext/core/bin/typo3 cleanup:versions -vv" does no action.
    V8 we can add all the action paramter variants there - but honestly I find the behavior missleading, because the default is a dry-run. I changed my code locally to execute all actions by default.
    v9 the command is gone... should be removed from docs.

History

#1 Updated by Jonas Eberle 16 days ago

Thank you for taking action on correcting this.
https://github.com/TYPO3/TYPO3.CMS/blob/master/typo3/sysext/lowlevel/README.rst

Could you propose how you would write it? If you want, push a patch to Gerrit (https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html)

Also available in: Atom PDF