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

From: Dave Hansen
Date: Wed Mar 15 2023 - 18:19:01 EST


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.