From: Randy Dunlap <rdunlap@infradead.org>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
"Dr. David Alan Gilbert" <linux@treblig.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
workflows@vger.kernel.org, linux-remoteproc@vger.kernel.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Danilo Krummrich <dakr@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Dwaipayan Ray <dwaipayanray1@gmail.com>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Joe Perches <joe@perches.com>,
Bjorn Andersson <andersson@kernel.org>,
Mathieu Poirier <mathieu.poirier@linaro.org>
Subject: Re: [PATCH v1 1/1] docs: Update documentation to avoid mentioning of kernel.h
Date: Wed, 26 Nov 2025 13:18:29 -0800 [thread overview]
Message-ID: <e5ca4be6-6919-4855-bb7f-bd36761eab0f@infradead.org> (raw)
In-Reply-To: <20251126205939.2321498-1-andriy.shevchenko@linux.intel.com>
On 11/26/25 12:59 PM, Andy Shevchenko wrote:
> For several years, and still ongoing, the kernel.h is being split
> to smaller and narrow headers to avoid "including everything" approach
> which is bad in many ways. Since that, documentation missed a few
> required updates to align with that work. Do it here.
>
> Note, language translations are left untouched and if anybody willing
> to help, please provide path(es) based on the updated English variant.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
> Documentation/core-api/kobject.rst | 2 +-
> Documentation/dev-tools/checkpatch.rst | 2 +-
> Documentation/driver-api/basics.rst | 17 ++++++++++++++++-
> .../driver-api/driver-model/design-patterns.rst | 2 +-
> Documentation/process/coding-style.rst | 10 +++++++---
> Documentation/staging/rpmsg.rst | 7 +++++--
> 6 files changed, 31 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 2969ca378dbb..d63ea0bffdfe 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -1070,7 +1070,7 @@ readability.
> 18) Don't re-invent the kernel macros
> -------------------------------------
>
> -The header file include/linux/kernel.h contains a number of macros that
> +There many header files in include/linux/ that contain a number of macros that
There are many
> you should use, rather than explicitly coding some variant of them yourself.
> For example, if you need to calculate the length of an array, take advantage
> of the macro
Otherwise LGTM. Thanks.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
--
~Randy
next prev parent reply other threads:[~2025-11-26 21:18 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-26 20:59 Andy Shevchenko
2025-11-26 21:18 ` Randy Dunlap [this message]
2025-11-26 21:24 ` Andy Shevchenko
2025-11-26 21:33 ` Randy Dunlap
2025-11-26 21:36 ` Randy Dunlap
2025-11-26 21:42 ` Andy Shevchenko
2025-11-26 21:46 ` Randy Dunlap
2025-11-26 21:49 ` Andy Shevchenko
2025-11-26 21:37 ` Andy Shevchenko
2025-11-26 21:39 ` Randy Dunlap
2025-11-26 21:39 ` Andy Shevchenko
2025-11-26 21:40 ` Randy Dunlap
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=e5ca4be6-6919-4855-bb7f-bd36761eab0f@infradead.org \
--to=rdunlap@infradead.org \
--cc=andersson@kernel.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=corbet@lwn.net \
--cc=dakr@kernel.org \
--cc=dwaipayanray1@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=linux@treblig.org \
--cc=lukas.bulwahn@gmail.com \
--cc=mathieu.poirier@linaro.org \
--cc=rafael@kernel.org \
--cc=workflows@vger.kernel.org \
/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