--config-dump option does not work

rizsotto / Bear

Bear is a tool that generates a compilation database for clang tooling.

GNU General Public License v3.0

4.79k stars 314 forks source link

--config-dump option does not work #402

Closed SamuelYvon closed 3 years ago

SamuelYvon commented 3 years ago

Describe the bug

In the documentation, it is specified that calling bear with --config-dump will print the read config. This is not the case:

> bear --config-dump -- make
Unrecognized parameter: "--config-dump"
Usage: bear [--output <arg>] [--verbose] -- ...

To Reproduce Steps to reproduce the behavior: bear --config-dump

Expected behavior

The read config being printed

Environment:

OS name: Linux
OS version: Pop!_OS 21.04
OS architecture: x86_64
Bear version: 3.0.8
Bear install method: apt

rizsotto commented 3 years ago

Hey @SamuelYvon , sorry for the confusion you've might refer to this wiki page, which is not really the user documentation. (It was served as a place where I can collect my thoughts on the config file subject. And as the first line says, it's for the future 3.1 version and not for the current 3.0.)

I recommend to read the man pages of the project. (There are 3 of them, and they are cross referencing to each other.) And this wiki page is trying to cover the edge cases too.

It is very probable that these man pages or wiki pages are not well written. I'm trying my best, but did not have many feedback on them, so not sure how can I improve them.

SamuelYvon commented 3 years ago

My bad. I went through the documentation. Thanks for the help!