From: Jiri Slaby <jirislaby@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Wan Jiabing <wanjiabing@vivo.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
kael_w@qq.com
Subject: Re: [PATCH] docs: serial: fix a reference file name in driver.rst
Date: Wed, 16 Mar 2022 08:49:24 +0100 [thread overview]
Message-ID: <af1c7dd1-d86d-d737-643e-1f20a19c3890@kernel.org> (raw)
In-Reply-To: <eee93a4c-2629-af0f-03b3-4379a128c7dd@kernel.org>
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@kernel.org> 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@vivo.com>
>>>>
>>>> Reviewed-by: Jiri Slaby <jirislaby@kernel.org>
>>>
>>> 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
next prev parent reply other threads:[~2022-03-16 7:49 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-04 10:03 [PATCH] docs: serial: fix a reference file name in driver.rst Wan Jiabing
2022-03-07 6:41 ` Jiri Slaby
2022-03-11 21:06 ` Jonathan Corbet
2022-03-12 6:59 ` Greg Kroah-Hartman
2022-03-14 6:16 ` Jiri Slaby
2022-03-16 7:49 ` Jiri Slaby [this message]
2022-03-16 21:43 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=af1c7dd1-d86d-d737-643e-1f20a19c3890@kernel.org \
--to=jirislaby@kernel.org \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=kael_w@qq.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wanjiabing@vivo.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.