I wholeheartedly agree with this blog post. I believe someone on here yesterday was asking about config file locations and setting them manually. This is in the same vein. I can’t tell you how many times a command line method for discovering the location of a config file would have saved me 30 minutes of googling.

  • bionade24@kbin.social
    link
    fedilink
    arrow-up
    34
    ·
    1 year ago

    What’s imho worse is how often config options or command flags don’t actually do at all what’s described in the manpage. I then have to dig into the source code once again and since you have to read through the whole behaviour it takes much longer than just looking up where the program tries to read config files.

    Please - if you find such wrong docs in Open source software, submit a fix to the doc. It’s as important as normal bugfixes.