From c69e3af7aff309f7dc68b2e702a49b692d13864e Mon Sep 17 00:00:00 2001 From: Ben Anson Date: Sat, 13 Mar 2021 01:36:32 +0000 Subject: [PATCH] doc: project_rooter_automatically (#4129) + some other minor corrections --- docs/documentation.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/documentation.md b/docs/documentation.md index 3fce24f5e..5ef08fddd 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -1923,8 +1923,8 @@ is based on on `project_rooter_patterns` option, and the default value is: project_rooter_patterns = ['.git/', '_darcs/', '.hg/', '.bzr/', '.svn/'] ``` -The project manager will find outermost directory by default, to find nearest directory, -you need to change `project_rooter_outermost` to `false`. +The project manager will find the outermost directory by default. To find the nearest directory instead, +you need to change `project_rooter_outermost` to `false`: ```toml [options] @@ -1932,8 +1932,8 @@ you need to change `project_rooter_outermost` to `false`. project_rooter_outermost = false ``` -Sometimes we want to ignore some directorys when detect the project root directory. -add a `!` prefix before the pattern. +Sometimes we want to ignore some directories when detecting the project root directory. +Add a `!` prefix before the pattern. For example, ignore `node_packages/` directory: ```toml @@ -1942,6 +1942,14 @@ For example, ignore `node_packages/` directory: project_rooter_outermost = false ``` +You can also disable project root detection completely (i.e. vim will set the +root directory to the present working directory): + +```toml +[options] + project_rooter_automatically = false +``` + Project manager commands start with `p`: | Key Bindings | Descriptions |