deoplete-plugins / deoplete-plugins/deoplete-clang

Misleading statement/mistake in the documentation with regards compliation_database

Open
#75 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
189
Forks
73
PR merge metrics
No merged PRs in 30d

Description

In the README it states that in your .clang file you want to point to a project specific compilation database you need to specify it like so:

> compilation_database = "\"

Actually you need to specify to the directory that contains it, rather than to the database itself.
i.e. if the file sits at `catkin_ws/build/compile_commands.json` your .clang file should say

`compliation_database = "catkin_ws/build/"`

at the moment it implies you need to put

`compilation_database = "catkin_ws/build/compile_commands.json"`

It's worth fixing this because I was stuck for hours trying to figure out what the problem was!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.