linux-kernel - Re: [PATCH] docs: serial: fix a reference file name in driver.rst

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] [day] [month] [year] [list]

Message-ID: <87k0ctshej.fsf@meer.lwn.net>
Date:   Wed, 16 Mar 2022 15:43:00 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Jiri Slaby <jirislaby@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc:     Wan Jiabing <wanjiabing@...o.com>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, kael_w@...com
Subject: Re: [PATCH] docs: serial: fix a reference file name in driver.rst

Jiri Slaby <jirislaby@...nel.org> writes:

> Returning to this: staring into Documentation/index.rst and 
> Documentation/driver-api/index.rst. Looking at documents/paths they 
> reference, I still don't quite understand what is the rule to put the 
> stuff to either of them.
>
> What I used to decide to put the tty stuff to the root is that it's not 
> only driver-api documented there. It documents also tty internals and 
> implementation of some line disciplines.
>
> So, now I'm confused why it does NOT belong to the root.

My thinking is: for the same reason that drivers/tty is not in the root.

I've been pushing for some time to get our documentation organized for
the readers, which means arranging things in terms of the expected
audience.  Much of what's in Documentation/tty looks like driver-api
stuff, so that's where I would like it to be.  If you have material for
other audiences, perhaps that material should go into a different book.

When I started doing this, "ls Documentation" would scroll on for many
pages.  We've been slowly moving away from that directory as an
unorganized dumping ground, but there is still a ways to go.

Thanks,

jon