linux-kernel - Re: [PULL] Docs for 4.13

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20170704132413.55274d6d@lwn.net>
Date:   Tue, 4 Jul 2017 13:24:13 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Linus Torvalds <torvalds@...ux-foundation.org>
Cc:     LKML <linux-kernel@...r.kernel.org>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>
Subject: Re: [PULL] Docs for 4.13

On Mon, 3 Jul 2017 21:32:33 -0700
Linus Torvalds <torvalds@...ux-foundation.org> wrote:

> Eg things like
> 
>   Error: Cannot open file ./kernel/rcu/srcu.c
>   Error: Cannot open file ./kernel/rcu/srcu.c
> 
> happen simply because that file no longer exists, and the docs never
> got updated.
> 
> So my merge didn't even try to fix those kinds of things at all.  I
> literally just looked at the conflicts and moved those over to the rst
> files, and that was it. There's a lot of other changes that never
> cause conflicts for the simple reason that those changes never caused
> documentation changes to begin with.
> 
> Now, this is obviously not new, but it does strike me that if checking
> for these kinds of things was easier and part of "make allmodconfig",
> then we might have less of it happen.

I see Markus already tossed out a patch using the sphinx "dummy mode".
It might be possible to create a dead-simple linter for this kind of
thing that would be quite a bit faster, but I wonder how much we really
need it.  Problems like this pop up with great regularity, but they
tend to be caught and fixed fairly quickly.  Meanwhile, the world
stubbornly refuses to end if the docs build tosses out a few (more)
errors for a few days. I don't think we have to slow down everybody's
build for this.

(Getting something into the build-and-boot testers might not be a bad
idea, though).

I've committed a patch to fix this particular problem, will send it
youward in a few days.

jon