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

From: Jiri Slaby
Date: Wed Mar 16 2022 - 03:49:30 EST


On 14. 03. 22, 7:16, Jiri Slaby wrote:
On 12. 03. 22, 7:59, Greg Kroah-Hartman wrote:
On Fri, Mar 11, 2022 at 02:06:00PM -0700, Jonathan Corbet wrote:
Jiri Slaby <jirislaby@xxxxxxxxxx> writes:

On 04. 03. 22, 11:03, Wan Jiabing wrote:
Fix the following 'make refcheckdocs' warning:
Warning: Documentation/driver-api/serial/driver.rst references a file
that doesn't exist: Documentation/driver-api/serial/tty.rst

Signed-off-by: Wan Jiabing <wanjiabing@xxxxxxxx>

Reviewed-by: Jiri Slaby <jirislaby@xxxxxxxxxx>

I've applied this.  But I have to wonder why Documentation/tty exists at
all; is there any reason not to move it all under driver-api?

No reason at all, it should probably be moved someday.

The only reason was that I don't completely understand what "driver-api" should contain. To be presice, documentation of line disciplines, tty buffer and tty internals (which is all contained in Documentation/tty) doesn't belong to "driver-api" IMO. If it it preferred to be there, I can move it, of course.

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.

thanks,
--
js
suse labs