On Mon, Sep 11, 2017 at 1:47 PM, Christoph Hellwig <hch@xxxxxxxxxxxxx> wrote: > On Mon, Sep 11, 2017 at 05:03:47AM +0200, Eugene Syromyatnikov wrote: >> Hello. >> >> I've noticed that some of Linux kernel in-tree documentation pointers >> are no longer valid and decided to check the validity for the rest of >> them with some one-liner. As it turned out, there are quite a few of >> them, in part due to latest ReST conversion effort. This patch set aims >> at amending documentation pointers that are no longer valid with the >> information about current location. I'm not quite sure about >> wording/formatting, and do not guarantee that I haven't miss anything, >> so I hope that this could be at least useful as a starting point. > > Do these pointers even have a place in man pages? I'd much rather > have anything that matters added to the man page instead. Well, the kernel documentation documents kernel side of things. Some of these pointers indeed due to some sort of sloppiness (mtrr andkeys references in proc.5, for example), but others are indeed useful, since contain significant amount of information needed for the full understanding of the topic (like crypto or key management APIs). Moreover, this documentation is better maintained by kernel developers for some reason, so there are more chances that it stays actual. I see them (especially in "See also" section) as a documents for additional information on the topic, like RFCs and stuff. -- Eugene Syromyatnikov mailto:evgsyr@xxxxxxxxx xmpp:esyr@jabber.{ru|org} -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
