Browse Source

Merge pull request #975 from willsALMANJ/patch-1

Explain how to get debug output with terminal vim
Val Markovic 11 years ago
parent
commit
feedc296db
1 changed files with 5 additions and 3 deletions
  1. 5 3
      CONTRIBUTING.md

+ 5 - 3
CONTRIBUTING.md

@@ -51,9 +51,11 @@ Here are the things you should do when creating an issue:
    let g:ycm_server_log_level = 'debug'
    ```
 
-   Then start gvim/macvim (not console vim) from the console. As you use Vim,
-   you'll see the `ycmd` debug output stream in the console. Attach that to you
-   issue.
+   Then, if possible, start gvim/macvim (not console vim) from the console. 
+   As you use Vim, you'll see the `ycmd` debug output stream in the console. 
+   If you can not use gvim/macvim, run `:YcmDebugInfo` in vim to see what 
+   temporary files (listed under "Server logfiles") the debug output streams 
+   are written to. Attach the debug output stream to your issue.
 3. **Create a test case for your issue**. This is critical. Don't talk about how
    "when I have X in my file" or similar, _create a file with X in it_ and put
    the contents inside code blocks in your issue description. Try to make this