Skip to content

Commit e3ba16d

Browse files
committed
docs: explain in more details how to troubleshoot updatedb
Link to the manual and give a command to print the content of the index.
1 parent 36720ed commit e3ba16d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,19 @@ Is your favorite SCM missing? It should be straightforward to support it by chan
250250

251251
This relies on a `locate` command to find repositories. This should be much faster than the `list` command, as it relies on a pre-built index but results may be stalled.
252252

253-
*Note*: at this point, the plugin does not manage index update. Updating the index often requires to run a command like `updatedb` as root.
253+
#### General Notes for `updatedb`
254+
255+
At this point, the plugin does not manage index update.
256+
257+
Updating the index often requires to run a command like `updatedb` as root. If the cached_list command does not return anything, it might be due to the configuration of the `updatedb` command. You can run `sudo updatedb -v --debug-pruning` to see if the directories you expect are indexed. You should see lines like the following if a repository named "rusqlie_migration" is indexed:
258+
259+
```
260+
/home/cjoly/worktree/rusqlite/rusqlite_migration/Cargo.toml
261+
/home/cjoly/worktree/rusqlite/rusqlite_migration/README.md
262+
/home/cjoly/worktree/rusqlite/rusqlite_migration/.git
263+
```
264+
265+
You might need to tweak the settings in the file `/etc/updatedb.conf`. The [corresponding manpage](https://man.archlinux.org/man/updatedb.conf.5) may be useful as well.
254266

255267
#### Notes for MacOS
256268

0 commit comments

Comments
 (0)