Re: [PATCH 2/2] Add documentation/arch/00-INDEX

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 04/25/2011 12:33 AM, Paul Mundt wrote:
> On Mon, Apr 25, 2011 at 12:07:48AM -0500, Rob Landley wrote:
>> On 04/24/2011 08:48 PM, Paul Mundt wrote:
>>> On Fri, Apr 22, 2011 at 11:53:50AM -0500, Rob Landley wrote:
>>>> +powerpc/
>>>> +	- Apple/IBM/Motorola PowerPC, http://penguinppc.org http://power.org
>>>> +s390/
>>>> +	- IBM S/390 and Z-series mainframes, http://linuxvm.org
>>>> +sh/
>>>> +	- Hitachi/Renesas SuperH (sh4): http://oss.renesas.com
>>>
>>> References to Hitachi are unecessary.
>>
>> Mention of the company that developed the chip is unnecessary?  I should
>> strip Apple off the PowerPC too, I take it?
>>
> There are other companies that make the IP too, and we don't itemize all
> of those, either. You'll note that I didn't recommend adding any one
> particular company name to the replacement line precisely because it is
> ambiguous. We could go in to IP history lessons, but it's quite frankly
> not worth the time or effort.
> 
>>> I also have no idea why you've listed sh4 here,
>>
>> For the same reason qemu-system-sh4 exists but qemu-system-sh doesn't?
>> Sort of like the x86/i386 directory being where the 32-bit docs live
>> (even though the 80386 ceased production in 2007).  "Here's the variant
>> you might have heard of."
>>
> qemu-system-sh doesn't exist simply because the qemu folks decided to
> only make an SH-4 port, which has absolutely nothing to do with the
> kernel. Try again.

Architecture not interesting enough for QEMU?

>> But sure, take that off too...
>>
>>> as that really has nothing to do with anything. The OSS
>>> site is also the wrong thing to use here.
>>>
>>> 	- SuperH architecture, see http://www.renesas.com/products/mpumcu/superh/superh_landing.jsp
>>>
>>> will be fine.
>>
>> Which is way over 80 characters.  (And everything in this directory is
>> an architecture, that's why the other lines don't say "architecture".
>> But even the tab, the minus, one space, the name "SuperH", one space,
>> and that link is still over 80 characters.)
>>
> If you're attempting to provide comprehensive links for platforms in the
> index file, hiding behind the 80 character limit seems a bit absurd.

I'm not.  The directory is there to contain the comprehensive
information, the 00-INDEX line is just a quick "what's this?".

(I've also noticed that the longer the link is, the more brittle it is
to site updates.  We don't have automated regression testing for our
documentation, link rot's a problem.)

Still, I guess your link will fit on its own line:

	- SuperH
	  http://www.renesas.com/products/mpumcu/superh/superh_landing.jsp

Well, it'll just about fit in 80 characters after the indent when my
email client isn't wordwrapping it, anyway.

>> I'll just revert this back to the original description currently in the
>> top level 00-INDEX for that directory, which "git blame" says has been
>> there unmodified for over 7 years, so changing it is orthogonal to
>> moving it.
>>
> Do as you like, I'll fix it up properly later.

Which is a good option too.  I'm just attempting to collate existing
documentation at this point, I don't claim to be an expert on every
platform out there.  (Haven't touched the content of any platform
directories.)

It's just a bit of a mess scattered in the top level like that.  The
source tree puts this in "arch" and Documentation/ should follow...

Rob
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux