|
|
Log in / Subscribe / Register

A report from the documentation maintainer

A report from the documentation maintainer

Posted Oct 27, 2016 17:54 UTC (Thu) by mchehab (subscriber, #41156)
In reply to: A report from the documentation maintainer by xtifr
Parent article: A report from the documentation maintainer

> Interestingly, there is significant disagreement over the removal of ancient, obsolete documentation. Do we really need, say, documentation from 1996 (http://static.lwn.net/kerneldoc/admin-guide/bug-hunting.html)

> > Wow, ok, not really my place to criticize any kernel devs, but the ones who don't want to "remove" obsolete documentation--do they not understand how git works?

My point, with regards to bug_hunting.html is that, except for one section there that it is really old (Finding it the old way), the remaining file provide useful tips that are still useful, like using git bisect to identify the bug source, and objdump/gdb to identify what part of the source code caused the bug.

So, IMHO, instead of dropping everything, we should drop just the outdated section, and improve the remaining document to reflect the current practices, like what I proposed on this patch:

https://marc.info/?l=linux-doc&m=147752366022236&w=2


to post comments

A report from the documentation maintainer

Posted Nov 4, 2016 12:54 UTC (Fri) by Wol (subscriber, #4433) [Link]

Or, what I'm trying to do on the linux raid wiki, have a section for obsolete stuff. So I've linked all the out-of-date stuff there, and as I rewrite it, the new stuff replaces the old on the main pages.

So all the old stuff is still there if it's wanted, but it's in a section flagged as "obsolete".

Cheers,
Wol


Copyright © 2026, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds