vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Correct subcommand usage. Clarify changing project usage

Browse Source
This commit is contained in:
Ben Jackson 2015-12-23 11:21:43 +00:00
parent 0162d4ad71
commit baba751dab
2 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -795,10 +795,15 @@ Alternatively, as described in the [Tern documentation][tern-docs], a global
`.tern-config` file may be used. `.tern-config` file may be used.
Currently, multiple Tern servers, are not supported. To switch to a different Currently, multiple Tern servers, are not supported. To switch to a different
project, change Vim's working directory (`:cd /path/to/new/project`), open a JavaScript project, you can do one of the following:
JavaScript file (or set filetype to JavaScript) and restart the Tern server
using YCM completer subcommands `:YcmCompleter StopServer` and - start a new instance of Vim from the new project's directory, or
`:YcmCompleter StartServer`. - change Vim's working directory (`:cd /path/to/new/project`) and restart the
`ycmd` server (`:YcmRestartServer`)
- change Vim's working directory (`:cd /path/to/new/project`), open a JavaScript
file (or set filetype to JavaScript) and restart the Tern server using YCM
completer subcommands `:YcmCompleter StopServer` and `:YcmCompleter
StartServer`.
#### Tips and tricks #### Tips and tricks
@ -1171,9 +1176,9 @@ auto x = &s; // invoking on x or auto returns "auto";
std::cout << *x; // invoking on x returns "const char ** => const char **" std::cout << *x; // invoking on x returns "const char ** => const char **"
``` ```
NOTE: Causes reparsing of the current translation unit. NOTE: Causes re-parsing of the current translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, typescript` Supported in filetypes: `c, cpp, objc, objcpp, typescript, javascript`
### The `GetParent` subcommand ### The `GetParent` subcommand
@ -1204,7 +1209,7 @@ For global declarations, the semantic parent is the translation unit.
NOTE: Causes re-parsing of the current translation unit. NOTE: Causes re-parsing of the current translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, typescript, javascript` Supported in filetypes: `c, cpp, objc, objcpp`
### The `FixIt` subcommand ### The `FixIt` subcommand
@ -1258,14 +1263,14 @@ javascript`
Starts the semantic-engine-as-localhost-server for those semantic engines that Starts the semantic-engine-as-localhost-server for those semantic engines that
work as separate servers that YCM talks to. work as separate servers that YCM talks to.
Supported in filetypes: `cs, javascript` Supported in filetypes: `cs, javascript, go`
### The `StopServer` subcommand ### The `StopServer` subcommand
Stops the semantic-engine-as-localhost-server for those semantic engines that Stops the semantic-engine-as-localhost-server for those semantic engines that
work as separate servers that YCM talks to. work as separate servers that YCM talks to.
Supported in filetypes: `cs, javascript` Supported in filetypes: `cs, javascript, go`
### The `RestartServer` subcommand ### The `RestartServer` subcommand

25
doc/youcompleteme.txt
View File

@ -1004,10 +1004,17 @@ Alternatively, as described in the Tern documentation [34], a global '.tern-
config' file may be used. config' file may be used.
Currently, multiple Tern servers, are not supported. To switch to a different Currently, multiple Tern servers, are not supported. To switch to a different
project, change Vim's working directory (':cd /path/to/new/project'), open a JavaScript project, you can do one of the following:
JavaScript file (or set filetype to JavaScript) and restart the Tern server
using YCM completer subcommands ':YcmCompleter StopServer' and ':YcmCompleter - start a new instance of Vim from the new project's directory, or
StartServer'.
- change Vim's working directory (':cd /path/to/new/project') and restart the
'ycmd' server (|:YcmRestartServer|)
- change Vim's working directory (':cd /path/to/new/project'), open a
JavaScript file (or set filetype to JavaScript) and restart the Tern server
using YCM completer subcommands ':YcmCompleter StopServer' and
':YcmCompleter StartServer'.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-tips-tricks* *youcompleteme-tips-tricks*
@ -1400,9 +1407,9 @@ For example:
// invoking on s returns "const char *" // invoking on s returns "const char *"
std::cout << *x; // invoking on x returns "const char ** => const char **" std::cout << *x; // invoking on x returns "const char ** => const char **"
< <
NOTE: Causes reparsing of the current translation unit. NOTE: Causes re-parsing of the current translation unit.
Supported in filetypes: 'c, cpp, objc, objcpp, typescript' Supported in filetypes: 'c, cpp, objc, objcpp, typescript, javascript'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *GetParent* subcommand The *GetParent* subcommand
@ -1432,7 +1439,7 @@ For global declarations, the semantic parent is the translation unit.
NOTE: Causes re-parsing of the current translation unit. NOTE: Causes re-parsing of the current translation unit.
Supported in filetypes: 'c, cpp, objc, objcpp, typescript, javascript' Supported in filetypes: 'c, cpp, objc, objcpp'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *FixIt* subcommand The *FixIt* subcommand
@ -1490,7 +1497,7 @@ The *StartServer* subcommand
Starts the semantic-engine-as-localhost-server for those semantic engines that Starts the semantic-engine-as-localhost-server for those semantic engines that
work as separate servers that YCM talks to. work as separate servers that YCM talks to.
Supported in filetypes: 'cs, javascript' Supported in filetypes: 'cs, javascript, go'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *StopServer* subcommand The *StopServer* subcommand
@ -1498,7 +1505,7 @@ The *StopServer* subcommand
Stops the semantic-engine-as-localhost-server for those semantic engines that Stops the semantic-engine-as-localhost-server for those semantic engines that
work as separate servers that YCM talks to. work as separate servers that YCM talks to.
Supported in filetypes: 'cs, javascript' Supported in filetypes: 'cs, javascript, go'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *RestartServer* subcommand The *RestartServer* subcommand