X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs-website;a=blobdiff_plain;f=vendor%2Fdrush%2Fdrush%2Fcommands%2Fcore%2Fdocs.drush.inc;fp=vendor%2Fdrush%2Fdrush%2Fcommands%2Fcore%2Fdocs.drush.inc;h=0000000000000000000000000000000000000000;hp=432f12b6e1a9ba0c56c31c198381c06b7f2258b6;hb=af6d1fb995500ae68849458ee10d66abbdcfb252;hpb=680c79a86e3ed402f263faeac92e89fb6d9edcc0 diff --git a/vendor/drush/drush/commands/core/docs.drush.inc b/vendor/drush/drush/commands/core/docs.drush.inc deleted file mode 100644 index 432f12b6e..000000000 --- a/vendor/drush/drush/commands/core/docs.drush.inc +++ /dev/null @@ -1,310 +0,0 @@ - TRUE to indicate the command is a topic (REQUIRED) - // Begin the topic name with the name of the commandfile (just like - // any other command). - // - $items['docs-readme'] = array( - 'description' => 'README.md', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/README.md'), - ); - $items['docs-bisect'] = array( - 'description' => 'git bisect and Drush may be used together to find the commit an error was introduced in.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/git-bisect.example.sh'), - ); - $items['docs-bashrc'] = array( - 'description' => 'Bashrc customization examples for Drush.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/example.bashrc'), - ); - $items['docs-configuration'] = array( - 'description' => 'Configuration overview with examples from example.drushrc.php.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/example.drushrc.php'), - ); - $items['docs-config-exporting'] = array( - 'description' => 'Drupal configuration export instructions, including customizing configuration by environment.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/config-exporting.md'), - ); - $items['docs-aliases'] = array( - 'description' => 'Site aliases overview on creating your own aliases for commonly used Drupal sites with examples from example.aliases.drushrc.php.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/example.aliases.drushrc.php'), - ); - $items['docs-ini-files'] = array( - 'description' => 'php.ini or drush.ini configuration to set PHP values for use with Drush.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/example.drush.ini'), - ); - $items['docs-bastion'] = array( - 'description' => 'Bastion server configuration: remotely operate on a Drupal sites behind a firewall.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/bastion.md'), - ); - $items['docs-bootstrap'] = array( - 'description' => 'Bootstrap explanation: how Drush starts up and prepares the Drupal environment for use with the command.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/bootstrap.md'), - ); - $items['docs-cron'] = array( - 'description' => 'Crontab instructions for running your Drupal cron tasks via `drush cron`.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/cron.md'), - ); - $items['docs-scripts'] = array( - 'description' => 'Shell script overview on writing simple sequences of Drush statements.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/shellscripts.md'), - ); - $items['docs-shell-aliases'] = array( - 'description' => 'Shell alias overview on creating your own aliases for commonly used Drush commands.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/shellaliases.md'), - ); - $items['docs-commands'] = array( - 'description' => 'Drush command instructions on creating your own Drush commands.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/commands.md'), - ); - $items['docs-errorcodes'] = array( - 'description' => 'Error code list containing all identifiers used with drush_set_error.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - ); - $items['docs-api'] = array( - 'description' => 'Drush API', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/drush.api.php'), - ); - $items['docs-context'] = array( - 'description' => 'Contexts overview explaining how Drush manages command line options and configuration file settings.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/context.md'), - ); - $items['docs-examplescript'] = array( - 'description' => 'Example Drush script.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/helloworld.script'), - ); - $items['docs-examplecommand'] = array( - 'description' => 'Example Drush command file.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/sandwich.drush.inc'), - ); - $items['docs-example-sync-extension'] = array( - 'description' => 'Example Drush commandfile that extends sql-sync to enable development modules in the post-sync hook.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/sync_enable.drush.inc'), - ); - $items['docs-example-sync-via-http'] = array( - 'description' => 'Example Drush commandfile that extends sql-sync to allow transfer of the sql dump file via http rather than ssh and rsync.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/sync_via_http.drush.inc'), - ); - $items['docs-policy'] = array( - 'description' => 'Example policy file.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/examples/policy.drush.inc'), - ); - $items['docs-strict-options'] = array( - 'description' => 'Strict option handling, and how commands that use it differ from regular Drush commands.', - 'hidden' => TRUE, - 'topic' => TRUE, - 'bootstrap' => DRUSH_BOOTSTRAP_NONE, - 'callback' => 'drush_print_file', - 'callback arguments' => array($docs_dir . '/docs/strict-options.md'), - ); - return $items; -} - -/** - * docs-errorcodes command. Print a list of all error codes - * that can be found. - */ -function drush_docs_errorcodes() { - $header = << $command) { - $files = array_merge($files, drush_command_get_includes($command_name)); - } - // We will also search through all of the .inc files in the - // drush includes directory - $drush_include_files = drush_scan_directory(DRUSH_BASE_PATH . '/includes', '/.*\.inc$/', array('.', '..', 'CVS'), 0, FALSE); - foreach ($drush_include_files as $filename => $info) { - $files[$filename] = 'include'; - } - - // Extract error messages from all command files - $error_list = array(); - foreach ($files as $file => $commandfile) { - _drush_docs_find_set_error_calls($error_list, $file, $commandfile); - } - // Order error messages alphabetically by key - ksort($error_list); - // Convert to a table - $data = array(); - foreach ($error_list as $error_code => $error_messages) { - $data[] = array($error_code, '-', implode("\n", $error_messages)); - } - - $tmpfile = drush_tempnam('drush-errorcodes.'); - file_put_contents($tmpfile, $header); - $handle = fopen($tmpfile, 'a'); - drush_print_table($data, FALSE, array(0 => 35), $handle); - fclose($handle); - drush_print_file($tmpfile); -} - -/** - * Search through a php source file looking for calls to - * the function drush_set_error. If found, and if the - * first parameter is an uppercase alphanumeric identifier, - * then record the error code and the error message in our table. - */ -function _drush_docs_find_set_error_calls(&$error_list, $filename, $shortname) { - $lines = file($filename); - foreach ($lines as $line) { - $matches = array(); - // Find the error code after the drush_set_error call. The error code - // should consist of uppercase letters and underscores only (numbers thrown in just in case) - $match_result = preg_match("/.*drush_set_error[^'\"]['\"]([A-Z0-9_]*)['\"][^,]*,[^'\"]*(['\"])/", $line, $matches); - if ($match_result) { - $error_code = $matches[1]; - $quote_char = $matches[2]; - $error_message = ""; - $message_start = strlen($matches[0]) - 1; - - // Regex adapted from http://stackoverflow.com/questions/1824325/regex-expression-for-escaped-quoted-string-wont-work-in-phps-preg-match-allif ($quote_char == '"') { - if ($quote_char == '"') { - $regex = '/"((?:[^\\\]*?(?:\\\")?)*?)"/'; - } - else { - $regex = "/'((?:[^\\\]*?(?:\\\')?)*?)'/"; - } - $match_result = preg_match($regex, $line, $matches, 0, $message_start); - - if ($match_result) { - $error_message = $matches[1]; - } - $error_list[$error_code] = array_key_exists($error_code, $error_list) ? array_merge($error_list[$error_code], array($error_message)) : array($error_message); - } - } -}