aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Friedman <maf675@gmail.com>2015-08-28 07:49:07 -0700
committerMatt Friedman <maf675@gmail.com>2015-08-28 07:49:07 -0700
commit6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9 (patch)
tree3db6d53d9783e8fb4bfcadc575e79be6262c2f15
parent13851f308f57e0cda4c24f9a9a186aac912213d1 (diff)
downloadforums-6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9.tar
forums-6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9.tar.gz
forums-6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9.tar.bz2
forums-6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9.tar.xz
forums-6c36f56b12afcb97dbaa7cc248435df3e7a3fdc9.zip
[ticket/14123] Remove redundant help messages
PHPBB3-14123
Diffstat
-rw-r--r--phpBB/language/en/cli.php87
-rw-r--r--phpBB/phpbb/console/command/cache/purge.php1
-rw-r--r--phpBB/phpbb/console/command/config/delete.php1
-rw-r--r--phpBB/phpbb/console/command/config/get.php1
-rw-r--r--phpBB/phpbb/console/command/config/increment.php1
-rw-r--r--phpBB/phpbb/console/command/config/set.php1
-rw-r--r--phpBB/phpbb/console/command/config/set_atomic.php1
-rw-r--r--phpBB/phpbb/console/command/cron/cron_list.php1
-rw-r--r--phpBB/phpbb/console/command/db/migrate.php1
-rw-r--r--phpBB/phpbb/console/command/dev/migration_tips.php1
-rw-r--r--phpBB/phpbb/console/command/extension/disable.php1
-rw-r--r--phpBB/phpbb/console/command/extension/enable.php1
-rw-r--r--phpBB/phpbb/console/command/extension/purge.php1
-rw-r--r--phpBB/phpbb/console/command/extension/show.php1
-rw-r--r--phpBB/phpbb/console/command/fixup/recalculate_email_hash.php1
15 files changed, 6 insertions, 95 deletions
diff --git a/phpBB/language/en/cli.php b/phpBB/language/en/cli.php
index 11d45646f8..0b73f95b60 100644
--- a/phpBB/language/en/cli.php
+++ b/phpBB/language/en/cli.php
@@ -55,7 +55,7 @@ $lang = array_merge($lang, array(
'CLI_DESCRIPTION_DISABLE_EXTENSION' => 'Disables the specified extension.',
'CLI_DESCRIPTION_ENABLE_EXTENSION' => 'Enables the specified extension.',
'CLI_DESCRIPTION_FIND_MIGRATIONS' => 'Finds migrations that are not depended upon.',
- 'CLI_DESCRIPTION_GET_CONFIG' => 'Gets a configuration option’s value',
+ 'CLI_DESCRIPTION_GET_CONFIG' => 'Gets a configuration option’s integer value',
'CLI_DESCRIPTION_INCREMENT_CONFIG' => 'Increments a configuration option’s value',
'CLI_DESCRIPTION_LIST_EXTENSIONS' => 'Lists all extensions in the database and on the filesystem.',
'CLI_DESCRIPTION_OPTION_SAFE_MODE' => 'Run in Safe Mode (without extensions).',
@@ -65,86 +65,6 @@ $lang = array_merge($lang, array(
'CLI_DESCRIPTION_SET_ATOMIC_CONFIG' => 'Sets a configuration option’s value only if the old matches the current value',
'CLI_DESCRIPTION_SET_CONFIG' => 'Sets a configuration option’s value',
- 'CLI_HELP_PURGE_CACHE' => 'The <info>%command.name%</info> command allows you to purge the board’s cache.
-
- <info>php %command.full_name%</info>
-',
- 'CLI_HELP_DELETE_CONFIG' => 'The <info>%command.name%</info> command deletes a configuration option. The key name is required.
-
- <info>php %command.full_name% config_key</info>
-',
- 'CLI_HELP_GET_CONFIG' => 'The <info>%command.name%</info> command gets a configuration option’s value. The key name is required.
-
- <info>php %command.full_name% config_key</info>
-',
- 'CLI_HELP_INCREMENT_CONFIG' => 'The <info>%command.name%</info> command increments an integer configuration option’s value. The key name and increment amount are required.
-
- <info>php %command.full_name% config_key 1</info>
-
-If the configuration option changes too frequently to be efficiently cached, use the <info>--dynamic</info> or <info>-d</info> option:
-
- <info>php %command.full_name% config_key 1 --dynamic</info>
- <info>php %command.full_name% config_key 1 -d</info>
-',
- 'CLI_HELP_SET_CONFIG' => 'The <info>%command.name%</info> sets a configuration option’s value. The key name and value are required.
-
- <info>php %command.full_name% config_key foo</info>
-
-If the configuration option changes too frequently to be efficiently cached, use the <info>--dynamic</info> or <info>-d</info> option:
-
- <info>php %command.full_name% config_key foo --dynamic</info>
- <info>php %command.full_name% config_key foo -d</info>
-',
- 'CLI_HELP_SET_ATOMIC_CONFIG' => 'The <info>%command.name%</info> command sets a configuration option’s value only if the old value matches the current value or the configuration value does not exist yet. The key name, old and new values are required.
-
- <info>php %command.full_name% config_name foo bar</info>
-
-If the configuration option changes too frequently to be efficiently cached, use the <info>--dynamic</info> or <info>-d</info> option:
-
- <info>php %command.full_name% config_key foo bar --dynamic</info>
- <info>php %command.full_name% config_key foo bar -d</info>
-',
- 'CLI_HELP_CRON_LIST' => 'The <info>%command.name%</info> command prints a list of ready and unready cron jobs.
-
- <info>php %command.full_name%</info>
-',
- 'CLI_HELP_CRON_RUN' => 'The <info>%command.name%</info> command runs all ready cron tasks.
-
- <info>php %command.full_name%</info>
-
-Optionally you can specify a cron task name to run only the specified cron task:
-
- <info>php %command.full_name% task_name</info>
-',
- 'CLI_HELP_DB_MIGRATE' => 'The <info>%command.name%</info> command updates the database by applying available migrations.
-
- <info>php %command.full_name%</info>
-',
- 'CLI_HELP_FIND_MIGRATIONS' => 'The <info>%command.name%</info> command finds migrations that are not depended upon.
-
- <info>php %command.full_name%</info>
-',
- 'CLI_HELP_DISABLE_EXTENSION' => 'The <info>%command.name%</info> command disables the specified extension. The extension name is required.
-
- <info>php %command.full_name% vendor_name/package_name</info>
-',
- 'CLI_HELP_ENABLE_EXTENSION' => 'The <info>%command.name%</info> command enables the specified extension. The extension name is required.
-
- <info>php %command.full_name% vendor_name/package_name</info>
-',
- 'CLI_HELP_PURGE_EXTENSION' => 'The <info>%command.name%</info> command purges the specified extension. The extension name is required.
-
- <info>php %command.full_name% vendor_name/package_name</info>
-',
- 'CLI_HELP_LIST_EXTENSIONS' => 'The <info>%command.name%</info> command lists all extensions in the database and on the filesystem.
-
- <info>php %command.full_name%</info>
-',
- 'CLI_HELP_RECALCULATE_EMAIL_HASH' => 'The <info>%command.name%</info> command recalculates the user_email_hash column of the users table.
-
- <info>php %command.full_name%</info>
-',
-
'CLI_EXTENSION_DISABLE_FAILURE' => 'Could not disable extension %s',
'CLI_EXTENSION_DISABLE_SUCCESS' => 'Successfully disabled extension %s',
'CLI_EXTENSION_ENABLE_FAILURE' => 'Could not enable extension %s',
@@ -159,3 +79,8 @@ Optionally you can specify a cron task name to run only the specified cron task:
'CLI_FIXUP_RECALCULATE_EMAIL_HASH_SUCCESS' => 'Successfully recalculated all email hashes.',
));
+
+// Additional help for commands.
+$lang = array_merge($lang, array(
+ 'CLI_HELP_CRON_RUN' => $lang['CLI_DESCRIPTION_CRON_RUN'] . ' Optionally you can specify a cron task name to run only the specified cron task.',
+));
diff --git a/phpBB/phpbb/console/command/cache/purge.php b/phpBB/phpbb/console/command/cache/purge.php
index 4a6c8cbbdd..d0c2ef6f72 100644
--- a/phpBB/phpbb/console/command/cache/purge.php
+++ b/phpBB/phpbb/console/command/cache/purge.php
@@ -60,7 +60,6 @@ class purge extends \phpbb\console\command\command
$this
->setName('cache:purge')
->setDescription($this->user->lang('PURGE_CACHE'))
- ->setHelp($this->user->lang('CLI_HELP_PURGE_CACHE'))
;
}
diff --git a/phpBB/phpbb/console/command/config/delete.php b/phpBB/phpbb/console/command/config/delete.php
index 51fe2165eb..efd276d7e3 100644
--- a/phpBB/phpbb/console/command/config/delete.php
+++ b/phpBB/phpbb/console/command/config/delete.php
@@ -26,7 +26,6 @@ class delete extends command
$this
->setName('config:delete')
->setDescription($this->user->lang('CLI_DESCRIPTION_DELETE_CONFIG'))
- ->setHelp($this->user->lang('CLI_HELP_DELETE_CONFIG'))
->addArgument(
'key',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/config/get.php b/phpBB/phpbb/console/command/config/get.php
index 688fafc753..9c03b49a3d 100644
--- a/phpBB/phpbb/console/command/config/get.php
+++ b/phpBB/phpbb/console/command/config/get.php
@@ -27,7 +27,6 @@ class get extends command
$this
->setName('config:get')
->setDescription($this->user->lang('CLI_DESCRIPTION_GET_CONFIG'))
- ->setHelp($this->user->lang('CLI_HELP_GET_CONFIG'))
->addArgument(
'key',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/config/increment.php b/phpBB/phpbb/console/command/config/increment.php
index a29473a471..b4d7438b66 100644
--- a/phpBB/phpbb/console/command/config/increment.php
+++ b/phpBB/phpbb/console/command/config/increment.php
@@ -27,7 +27,6 @@ class increment extends command
$this
->setName('config:increment')
->setDescription($this->user->lang('CLI_DESCRIPTION_INCREMENT_CONFIG'))
- ->setHelp($this->user->lang('CLI_HELP_INCREMENT_CONFIG'))
->addArgument(
'key',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/config/set.php b/phpBB/phpbb/console/command/config/set.php
index 14ee9a2deb..695de31013 100644
--- a/phpBB/phpbb/console/command/config/set.php
+++ b/phpBB/phpbb/console/command/config/set.php
@@ -27,7 +27,6 @@ class set extends command
$this
->setName('config:set')
->setDescription($this->user->lang('CLI_DESCRIPTION_SET_CONFIG'))
- ->setHelp($this->user->lang('CLI_HELP_SET_CONFIG'))
->addArgument(
'key',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/config/set_atomic.php b/phpBB/phpbb/console/command/config/set_atomic.php
index cff89d5157..e8c69a0885 100644
--- a/phpBB/phpbb/console/command/config/set_atomic.php
+++ b/phpBB/phpbb/console/command/config/set_atomic.php
@@ -27,7 +27,6 @@ class set_atomic extends command
$this
->setName('config:set-atomic')
->setDescription($this->user->lang('CLI_DESCRIPTION_SET_ATOMIC_CONFIG'))
- ->setHelp($this->user->lang('CLI_HELP_SET_ATOMIC_CONFIG'))
->addArgument(
'key',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/cron/cron_list.php b/phpBB/phpbb/console/command/cron/cron_list.php
index 418f2d8c76..c515fd9e80 100644
--- a/phpBB/phpbb/console/command/cron/cron_list.php
+++ b/phpBB/phpbb/console/command/cron/cron_list.php
@@ -40,7 +40,6 @@ class cron_list extends \phpbb\console\command\command
$this
->setName('cron:list')
->setDescription($this->user->lang('CLI_DESCRIPTION_CRON_LIST'))
- ->setHelp($this->user->lang('CLI_HELP_CRON_LIST'))
;
}
diff --git a/phpBB/phpbb/console/command/db/migrate.php b/phpBB/phpbb/console/command/db/migrate.php
index e279e8ee0c..87c2a057d1 100644
--- a/phpBB/phpbb/console/command/db/migrate.php
+++ b/phpBB/phpbb/console/command/db/migrate.php
@@ -52,7 +52,6 @@ class migrate extends \phpbb\console\command\command
$this
->setName('db:migrate')
->setDescription($this->user->lang('CLI_DESCRIPTION_DB_MIGRATE'))
- ->setHelp($this->user->lang('CLI_HELP_DB_MIGRATE'))
;
}
diff --git a/phpBB/phpbb/console/command/dev/migration_tips.php b/phpBB/phpbb/console/command/dev/migration_tips.php
index 03d81a72a2..f9047bdac8 100644
--- a/phpBB/phpbb/console/command/dev/migration_tips.php
+++ b/phpBB/phpbb/console/command/dev/migration_tips.php
@@ -31,7 +31,6 @@ class migration_tips extends \phpbb\console\command\command
$this
->setName('dev:migration-tips')
->setDescription($this->user->lang('CLI_DESCRIPTION_FIND_MIGRATIONS'))
- ->setHelp($this->user->lang('CLI_HELP_FIND_MIGRATIONS'))
;
}
diff --git a/phpBB/phpbb/console/command/extension/disable.php b/phpBB/phpbb/console/command/extension/disable.php
index dae63c4076..1eee16cbd9 100644
--- a/phpBB/phpbb/console/command/extension/disable.php
+++ b/phpBB/phpbb/console/command/extension/disable.php
@@ -23,7 +23,6 @@ class disable extends command
$this
->setName('extension:disable')
->setDescription($this->user->lang('CLI_DESCRIPTION_DISABLE_EXTENSION'))
- ->setHelp($this->user->lang('CLI_HELP_DISABLE_EXTENSION'))
->addArgument(
'extension-name',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/extension/enable.php b/phpBB/phpbb/console/command/extension/enable.php
index 94baaa0f44..59ff11e9b7 100644
--- a/phpBB/phpbb/console/command/extension/enable.php
+++ b/phpBB/phpbb/console/command/extension/enable.php
@@ -23,7 +23,6 @@ class enable extends command
$this
->setName('extension:enable')
->setDescription($this->user->lang('CLI_DESCRIPTION_ENABLE_EXTENSION'))
- ->setHelp($this->user->lang('CLI_HELP_ENABLE_EXTENSION'))
->addArgument(
'extension-name',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/extension/purge.php b/phpBB/phpbb/console/command/extension/purge.php
index b9fa038a4b..517e9a74c9 100644
--- a/phpBB/phpbb/console/command/extension/purge.php
+++ b/phpBB/phpbb/console/command/extension/purge.php
@@ -23,7 +23,6 @@ class purge extends command
$this
->setName('extension:purge')
->setDescription($this->user->lang('CLI_DESCRIPTION_PURGE_EXTENSION'))
- ->setHelp($this->user->lang('CLI_HELP_PURGE_EXTENSION'))
->addArgument(
'extension-name',
InputArgument::REQUIRED,
diff --git a/phpBB/phpbb/console/command/extension/show.php b/phpBB/phpbb/console/command/extension/show.php
index 2e703e7156..f9322034d7 100644
--- a/phpBB/phpbb/console/command/extension/show.php
+++ b/phpBB/phpbb/console/command/extension/show.php
@@ -22,7 +22,6 @@ class show extends command
$this
->setName('extension:show')
->setDescription($this->user->lang('CLI_DESCRIPTION_LIST_EXTENSIONS'))
- ->setHelp($this->user->lang('CLI_HELP_LIST_EXTENSIONS'))
;
}
diff --git a/phpBB/phpbb/console/command/fixup/recalculate_email_hash.php b/phpBB/phpbb/console/command/fixup/recalculate_email_hash.php
index 94592409c5..ec4e1b0ee7 100644
--- a/phpBB/phpbb/console/command/fixup/recalculate_email_hash.php
+++ b/phpBB/phpbb/console/command/fixup/recalculate_email_hash.php
@@ -32,7 +32,6 @@ class recalculate_email_hash extends \phpbb\console\command\command
$this
->setName('fixup:recalculate-email-hash')
->setDescription($this->user->lang('CLI_DESCRIPTION_RECALCULATE_EMAIL_HASH'))
- ->setHelp($this->user->lang('CLI_HELP_RECALCULATE_EMAIL_HASH'))
;
}
generated by cgit v1.2.1 (git 2.21.0) at 2025-05-19 21:01:30 +0000