nextcloud / server

☁️ Nextcloud server, a safe home for all your data
https://nextcloud.com
GNU Affero General Public License v3.0
27.51k stars 4.08k forks source link

feat(files): Add help to / update description of `files:cleanup` #49407

Closed joshtrichards closed 4 days ago

joshtrichards commented 5 days ago

Summary

After:

Output of occ files:

[...]
Available commands for the "files" namespace:
  files:cleanup                    Clean up orphaned filecache and mount entries
  files:copy                       Copy a file or folder
  [...]

Output of files:cleanup --help:

Description:
  Clean up orphaned filecache and mount entries

Usage:
  files:cleanup [options]

Options:
      --skip-filecache-extended  don't remove orphaned entries from filecache_extended
  -h, --help                     Display help for the given command. When no command is given display help for the list command
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi|--no-ansi           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --no-warnings              Skip global warnings, show command output only
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  Deletes orphaned filecache and mount entries (those without an existing storage).

Before:

Output of occ files:

[...]
Available commands for the "files" namespace:
  files:cleanup                    cleanup filecache
  files:copy                       Copy a file or folder
[...]

Output of files:cleanup --help:

Description:
  cleanup filecache

Usage:
  files:cleanup [options]

Options:
      --skip-filecache-extended  don't remove orphaned entries from filecache_extended
  -h, --help                     Display help for the given command. When no command is given display help for the list command
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi|--no-ansi           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --no-warnings              Skip global warnings, show command output only
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Historical context:

TODO

Checklist