浏览代码

Add docs for diag command

Jordi Boggiano 12 年之前
父节点
当前提交
7740196b13
共有 2 个文件被更改,包括 14 次插入3 次删除
  1. 8 0
      doc/03-cli.md
  2. 6 3
      doc/articles/troubleshooting.md

+ 8 - 0
doc/03-cli.md

@@ -348,6 +348,14 @@ performance.
   autoloader. This is recommended especially for production, but can take
   a bit of time to run so it is currently not done by default.
 
+## diag
+
+If you think you found a bug, or something is behaving strangely, you might
+want to run the `diag` command to perform automated checks for many common
+problems.
+
+    $ php composer.phar diag
+
 ## help
 
 To get more information about a certain command, just use `help`.

+ 6 - 3
doc/articles/troubleshooting.md

@@ -7,13 +7,16 @@ This is a list of common pitfalls on using Composer, and how to avoid them.
 
 ## General
 
-1. When facing any kind of problems using Composer, be sure to **work with the
+1. Before asking anyone, run [`composer diag`](../03-cli.md#diag) to check
+   for common problems. If it all checks out, proceed to the next steps.
+
+2. When facing any kind of problems using Composer, be sure to **work with the
    latest version**. See [self-update](../03-cli.md#self-update) for details.
 
-2. Make sure you have no problems with your setup by running the installer's
+3. Make sure you have no problems with your setup by running the installer's
    checks via `curl -sS https://getcomposer.org/installer | php -- --check`.
 
-3. Ensure you're **installing vendors straight from your `composer.json`** via
+4. Ensure you're **installing vendors straight from your `composer.json`** via
    `rm -rf vendor && composer update -v` when troubleshooting, excluding any
    possible interferences with existing vendor installations or `composer.lock`
    entries.