On Sun, 2019-03-10 at 18:20 +0100, Andreas P wrote: > The current Documentation needs to be reviewed. The ones I would like to focus > on are those that are actively watched by the user. > Which is often the README and the man pages. Yes, that needs work. > > In this mail I would like to address the README page. > The README currently have URL links that lead to pages that have gone offline > and the information that is present is not up to date. > For example: > > http://www.Linux-Consulting.com/Amd_AutoFS/autofs.html > http://news.gmane.org/gmane.linux.kernel.autofs > http://blog.gmane.org/gmane.linux.kernel.autofs > > Does not work. There's currently no archive associated with the vger mailing list. Remove references to mailing list archives. > > "Limited direct mount functionality has been implemented and a > describtion of what can be done can be found in README.direct." Remove it, that's not true any more. > > "See README.ghosting" It might be worth creating a README.browse, or similar, as there are a couple of things worth being aware of when using that option and the "--ghost" is deprecated in favour of the "browse" option. > > These files does not exist anymore. > > What information do we want to present in the README file? What is relevant > for the user to know about the current build? To start with bringing it up to date will be enough. The README.options doesn't exist either and it's not worth creating one, using "./configure --help" should be used to discover what options are available. Ian
