Skip to content

Commit bed442f

Browse files
committed
move troubleshooting from readme to wiki
1 parent 77dd666 commit bed442f

File tree

1 file changed

+0
-39
lines changed

1 file changed

+0
-39
lines changed

README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -147,45 +147,6 @@ Custom actions may be mapped which can invoke API or perform your own actions.
147147

148148
[:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
149149

150-
## Troubleshooting
151-
152-
## Diagnostic Logging
153-
154-
You may enable diagnostic logging to `$XDG_CACHE_HOME/nvim/nvim-tree.log`. See [:help nvim-tree.log](doc/nvim-tree-lua.txt)
155-
156-
## netrw Keeps Popping Up
157-
158-
Eagerly disable netrw. See [:help nvim-tree.disable_netrw](doc/nvim-tree-lua.txt)
159-
160-
## Performance Issues
161-
162-
If you are experiencing performance issues with nvim-tree.lua, you can enable profiling in the logs. It is advisable to enable git logging at the same time, as that can be a source of performance problems.
163-
164-
```lua
165-
log = {
166-
enable = true,
167-
truncate = true,
168-
types = {
169-
diagnostics = true,
170-
git = true,
171-
profile = true,
172-
watcher = true,
173-
},
174-
},
175-
```
176-
177-
Please attach `$XDG_CACHE_HOME/nvim/nvim-tree.log` if you raise an issue.
178-
179-
*Performance Tips:*
180-
181-
* If you are using fish as an editor shell (which might be fixed in the future), try set `shell=/bin/bash` in your vim config. Alternatively, you can [prevent fish from loading interactive configuration in a non-interactive shell](https://github.com/nvim-tree/nvim-tree.lua/issues/549#issuecomment-1127394585).
182-
183-
* Try manually running the git command (see the logs) in your shell e.g. `git --no-optional-locks status --porcelain=v1 --ignored=matching -u`.
184-
185-
* Huge git repositories may timeout after the default `git.timeout` of 400ms. Try increasing that in your setup if you see `[git] job timed out` in the logs.
186-
187-
* Try temporarily disabling git integration by setting `git.enable = false` in your setup.
188-
189150
## Contributing
190151

191152
PRs are always welcome. See [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)