linux-kernel - Re: [PATCH RFC 0/2] Begin reorganizing the arch documentation

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: <fe5d1e0e-0725-45eb-8b96-edcd12ae4a8b@intel.com>
Date:   Wed, 15 Mar 2023 15:18:28 -0700
From:   Dave Hansen <dave.hansen@...el.com>
To:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, linux-arch@...r.kernel.org,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>,
        Dave Hansen <dave.hansen@...ux.intel.com>, x86@...nel.org,
        Peter Zijlstra <peterz@...radead.org>,
        Borislav Petkov <bp@...en8.de>
Subject: Re: [PATCH RFC 0/2] Begin reorganizing the arch documentation

On 3/15/23 14:15, Jonathan Corbet wrote:
> On the other hand, it *is* a fair amount of churn.  If it's more than
> people can handle, I'll quietly back away and we'll muddle along as we have
> been; this isn't something I'm going to dig in my heels over.

I'm not fundamentally opposed to this.  It'll probably cost me a few
keystrokes in moments of confusion, but that's the price of progress. :)

Things in Documentation/ have also been mobile enough in recent years
that I tend to "find Documentation | grep something" rather than try to
remember the paths for things.  Adding an arch/ in there won't hurt
anything.

> Also, it is worth noting that, while the rendered HTML looks the same,
> links that went to Documentation/x86 (on https://kernel.org, say) will be
> broken by this change.  We have never considered whether we care about
> preserving external links to the rendered docs on kernel.org or not; I
> don't think we should break them without thinking about it.

I don't think this is a big deal.  Folks that are doing explicit versions:

	https://www.kernel.org/doc/html/v6.0/x86/

won't break and folks that are using "latest":

	https://www.kernel.org/doc/html/latest/x86/

are kinda already playing with fire.  I guess we could ask the
kernel.org admins to see how many 404's folks get after the docs get
moved.  They could _theoretically_ redirect users from the old to new URL:

	doc/html/latest/x86 => doc/html/latest/arch/x86

but I doubt it's worth it for this one little directory.