抛弃过时的文档基础设施
很久以前,Linux 内核开始使用 00-Index 文件来列出每个文档目录的内容。目的是解释每个文件记录的内容。 Henrik Austad 最近指出,这些文件已经过时很久了,可能没人再使用了。这已经不是什么新鲜事了。 Henrik 在他的帖子中说,这个问题已经被讨论了多年,“而且它们从那时起变得更加过时,所以也许现在是时候把它们扔掉了。”
他统计了数百个 00-index 文件过时或应该存在但不存在的情况。 他发布了一个补丁,无情地将它们从内核中移除。
Joe Perches 对此非常满意。 他指出,.rst 文件(内核的本机文档格式)在很大程度上已经取代了 00-index 文件的原始目的。 他说 oo-index 文件现在甚至具有误导性。
Jonathan Corbet 则较为保守。 他认为 Henrik 应该在更广泛的受众中分发补丁,看看是否会受到任何阻力。 他补充说
我还没有决定这是否是一个好主意。 对于 RST doctree 中的内容,我们当然不需要这些文件,因为 index.rst 文件就是为此目的而设的。 但我怀疑有些人可能会抱怨失去其余内容的文件。 我确实收到了人们更新它们的补丁,所以确实有人在看它们。
Henrik 告诉 Jonathan,如果可以的话,他很乐意更新 00-index 文件。 但如果正确的答案只是摆脱它们,他不想这样做。
与此同时,Josh Triplett 认为完全没有理由保留 00-index 文件。 他评论说:“在浏览这些文件时,我 *短暂地* 想要建议确保 00-INDEX 文件中的单行描述最终出现在文档本身中,但我想得越多,就越觉得即使这样做也不值得任何人花时间去做。”
Paul Moore 也表示支持删除 00-index 文件,至少是关于 NetLabel 的文件,这是他感兴趣的领域。
讨论到此结束。 即使对于明显是显而易见的补丁,开发人员仍然花时间考虑各种观点,并努力保留旧事物中的任何价值,这真是太好了。 尤其令人高兴的是,这种关注也给予了文档补丁,这些补丁在编码项目中往往被冷落。
注意:如果您在上面被提及并且想在评论区上方发表回复,请将包含您的回复文本的消息发送至 ljeditor@linuxjournal.com。