All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "René Nyffenegger" <mail@renenyffenegger.ch>, linux-doc@vger.kernel.org
Subject: Re: [PATCH] Documentation: Reference kernel-doc for container_of
Date: Thu, 14 Sep 2023 15:08:26 -0600	[thread overview]
Message-ID: <87edj0fool.fsf@meer.lwn.net> (raw)
In-Reply-To: <3e593638-fdaa-4f68-86b4-a4c8dae412dc@renenyffenegger.ch>

René Nyffenegger <mail@renenyffenegger.ch> writes:

> On 9/1/23 16:22, Jonathan Corbet wrote:
>> René Nyffenegger <mail@renenyffenegger.ch> writes:
>>
>>> The file include/linux/container_of.h contained kernel-doc but was not
>>> referenced in any .rst file. In addition, the file
>>> Documentation/core-api/kobject.rst wrongly located the definition
>>> of the macro `container_of` in linux/kernel.h while in reality
>>> it is defined in linux/container_of.h
>>>
>>> This patch adds a new .rst file that includes the kernel-doc of
>>> container_of.h and rectifies the wrong reference of the header
>>> file.
>>>
>>> Signed-off-by: René Nyffenegger <mail@renenyffenegger.ch>
>> Thank you for working to improve the kernel documentation!
>>
>> There are, though, a few problems with this patch that will need to be
>> addressed before it can be accepted.  To start, please cc the maintainer
>> (i.e. me) on documentation changes.
>>
> Thanks for looking at my attempt to patch the documentations.
>
> I tried to create an improved patch:
> https://lore.kernel.org/linux-doc/20230902210422.8092-1-mail@renenyffenegger.ch/T/
>
> However, I did not receive any feedback. So, I am wondering if I am
> still making mistakes. In order to improve, I'd appreciate a feedback
> what I need to change to create the patch.

Sorry, I do have feedback, but between the merge window and travel I've
fallen behind on things.  I'll get there, honest.

Thanks,

jon

  reply	other threads:[~2023-09-14 21:08 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-01  7:07 [PATCH] Documentation: Reference kernel-doc for container_of René Nyffenegger
2023-09-01 14:22 ` Jonathan Corbet
2023-09-14  6:07   ` René Nyffenegger
2023-09-14 21:08     ` Jonathan Corbet [this message]
  -- strict thread matches above, loose matches on Subject: below --
2023-09-05 11:16 René Nyffenegger

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=87edj0fool.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mail@renenyffenegger.ch \
    /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.