I do not think this risk-prone command (or any risk-prone subsystem) should be documented via example.
People will copy. They won't understand. They won't try to understand. By not providing an example, we force them to learn, and only use the minimum. Giving people lines to "tweak" results in them over-selecting without study. clematis <[email protected]> wrote: > Hello, > Looking arround in /etc/examples/ I felt like some of those files aren't > as "verbose" as others. For example doas.conf > doas.conf(5) contains more EXAMPLES than /etc/examples/doas.conf > > Please let me know if there is a prefered way. > 1/ document EXAMPLES in the manpage, only have examples config file for > daemon? (The relayd.conf example file is very verbose in comparaison, > which don't get me wrong is a very good thing) > 2/ or try to keep both aligned and consistent (they always point to each > others but yes one change in the EXAMPLES of a manpage could also > require a change in the example config file) so we could arguee it's > duplicating the effort. > > And there's probably a middle ground that could be find as well. > I don't know if anyone has a strong opinion or recommandations. > > So if that makes sense for you, please find attached a patch for > examples/doas.conf adding the main examples from doas.conf(5) and > bsd.port.mk(5). > Also a quick patch for doas.conf(5) to use an absolute path as > recommended. > > Cheers, > -- > clematis (0x7e96fd2400fe7b59)
