[Ksummit-discuss] [MAINTAINERS SUMMIT] Documentation issues

[Takashi Iwai]

On Sun, 25 Jun 2017 22:56:07 +0200,
Jiri Kosina wrote:
> 
> On Sat, 24 Jun 2017, Mauro Carvalho Chehab wrote:
> 
> > > There are pieces of .txt documentation falling into the "well-knows source of
> > > information" category, with many references to them all over the Web.
> > > kernel-parameters.txt is probably the most spectacular example here, but there
> > > are others.
> > > 
> > > Let us not move or rename these, please, or at least put symbolic links in
> > > place to point to the new locations or similar, such that the existing WWW
> > > links pointing to the documentation at kernel.org still work going forward.
> > > 
> > > And if we have moved or renamed them already, can we possibly make these
> > > links work again somehow?
> > 
> > Agreed. We discussed in the past about two alternatives for those
> > "well known" documents:
> > 
> > 	1) write a small text on the old file pointing to the
> > 	   new location;
> > 	2) use symlink.
> > 
> > Right now, we're actually mixing (1) and (2). IMHO, we should either
> > do (1) or (2).
> 
> Unfortunately option (3) has also been applied to some of the files:
> 
> 	$ ll Documentation/kernel-parameters.txt
> 	ls: cannot access 'Documentation/kernel-parameters.txt': No such file or directory
> 
> I wasn't sure whether this was intentional or not. But if not, I'll 
> happily send a patch that introduces a symlink.

If we do symlinks, wouldn't it be cleaner to separate the old doc
directory from the new doc directory?  That is, Documentation/* keeps
the old txt or symlinks while the ReST is put in another directory,
say, docs/* as originally suggested.


thanks,

Takashi