From: Jonathan Corbet <corbet@lwn.net>
To: Michael Witten <mfwitten@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Jeff Kirsher <jeffrey.t.kirsher@intel.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: driver-model: bus.rst: Clean up the formatting, expound, modernize
Date: Mon, 11 Jan 2021 13:31:58 -0700 [thread overview]
Message-ID: <20210111133158.34923b4c@lwn.net> (raw)
In-Reply-To: <3dc7d8abd06941fca5071b0ede9b6088@gmail.com>
On Mon, 21 Dec 2020 07:52:00 -0000
Michael Witten <mfwitten@gmail.com> wrote:
> * The reStructuredText had some indentation issues.
>
> * The HTML output was not properly formatted in places.
>
> * Some of the details were lacking or needed clarification (especially
> with regard to how a `struct bus_type` object should be defined).
>
> * The sysfs example hierarchy appeared outdated; I've updated it with
> output based on what my own system currently displays.
>
> Signed-off-by: Michael Witten <mfwitten@gmail.com>
> ---
> Documentation/driver-api/driver-model/bus.rst | 110 +++++++++++++--------
> 1 file changed, 67 insertions(+), 43 deletions(-)
Thanks for working to improve the docs. I have a couple of requests,
though...
> diff --git a/Documentation/driver-api/driver-model/bus.rst b/Documentation/driver-api/driver-model/bus.rst
> index 016b15a6e8ea..68a95389b1eb 100644
> --- a/Documentation/driver-api/driver-model/bus.rst
> +++ b/Documentation/driver-api/driver-model/bus.rst
> @@ -4,34 +4,58 @@ Bus Types
>
> Definition
> ~~~~~~~~~~
> -See the kerneldoc for the struct bus_type.
> -
> -int bus_register(struct bus_type * bus);
> +* ``struct bus_type``;
> +* ``int bus_register(struct bus_type *bus);``
This should just be made into a literal block like the others.
> Declaration
> ~~~~~~~~~~~
>
> -Each bus type in the kernel (PCI, USB, etc) should declare one static
> -object of this type. They must initialize the name field, and may
> -optionally initialize the match callback::
> +For each bus type (PCI, USB, etc), there should be code that defines
> +one object of type ``struct bus_type``:
It is better not to mark types as ``literal`` this way; the build system is
getting better at recognizing such things on its own and generating the
appropriate links.
[...]
> Registration
> ~~~~~~~~~~~~
>
> -When a bus driver is initialized, it calls bus_register. This
> -initializes the rest of the fields in the bus object and inserts it
> -into a global list of bus types. Once the bus object is registered,
> +During initialization of a bus driver, ``bus_register()`` is called; this
*definitely* don't mark functions as literal in this way; simply say
bus_register() and the Right Things will happen.
Thanks,
jon
next prev parent reply other threads:[~2021-01-11 20:32 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-21 7:52 [PATCH] docs: driver-model: bus.rst: Clean up the formatting, expound, modernize Michael Witten
2021-01-11 20:31 ` Jonathan Corbet [this message]
2021-01-13 5:35 ` [PATCH v2] " Michael Witten
2021-01-18 20:20 ` 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=20210111133158.34923b4c@lwn.net \
--to=corbet@lwn.net \
--cc=jeffrey.t.kirsher@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mfwitten@gmail.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).