All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <Jonathan.Cameron@Huawei.com>
To: Andrew Jeffery <andrew@codeconstruct.com.au>
Cc: <minyard@acm.org>, <openipmi-developer@lists.sourceforge.net>,
	<linux-kernel@vger.kernel.org>, <aladyshev22@gmail.com>,
	<jk@codeconstruct.com.au>
Subject: Re: [PATCH 10/10] ipmi: kcs_bmc: Add subsystem kerneldoc
Date: Fri, 3 Nov 2023 15:12:30 +0000	[thread overview]
Message-ID: <20231103151230.0000161e@Huawei.com> (raw)
In-Reply-To: <20231103061522.1268637-11-andrew@codeconstruct.com.au>

On Fri,  3 Nov 2023 16:45:22 +1030
Andrew Jeffery <andrew@codeconstruct.com.au> wrote:

> Provide kerneldoc describing the relationships between and the
> behaviours of the structures and functions of the KCS subsystem.
> 
> Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
Seems reasonable but I've only a superficial idea of how this all fits
together so no tag from me.

There is the fun question of whether function documentation should be
next to the implementation or in the header.  As long as it's
consistent in a given subsystem I don't personally thing it matters
that much.

Jonathan

  reply	other threads:[~2023-11-03 15:12 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-03  6:15 [PATCH 00/10] ipmi: kcs_bmc: Miscellaneous cleanups Andrew Jeffery
2023-11-03  6:15 ` [PATCH 01/10] ipmi: kcs_bmc: Update module description Andrew Jeffery
2023-11-03 14:34   ` Jonathan Cameron
2023-11-03  6:15 ` [PATCH 02/10] ipmi: kcs_bmc: Include spinlock.h Andrew Jeffery
2023-11-03 14:36   ` Jonathan Cameron
2023-11-05 22:47     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 03/10] ipmi: kcs_bmc: Make kcs_bmc_update_event_mask() static Andrew Jeffery
2023-11-03 14:40   ` Jonathan Cameron
2023-11-05 22:52     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 04/10] ipmi: kcs_bmc: Make remove_device() callback return void Andrew Jeffery
2023-11-03 14:43   ` Jonathan Cameron
2023-11-05 22:54     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 05/10] ipmi: kcs_bmc: Define client actions in terms of kcs_bmc_client Andrew Jeffery
2023-11-03 15:16   ` Jonathan Cameron
2023-11-07  6:32     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 06/10] ipmi: kcs_bmc: Integrate buffers into driver struct Andrew Jeffery
2023-11-03 14:45   ` Jonathan Cameron
2023-11-05 22:55     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 07/10] ipmi: kcs_bmc: Disassociate client from device lifetimes Andrew Jeffery
2023-11-03 14:51   ` Jonathan Cameron
2023-11-05 23:01     ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 08/10] ipmi: kcs_bmc: Track clients in core Andrew Jeffery
2023-11-03 15:05   ` Jonathan Cameron
2023-11-05 23:56     ` Andrew Jeffery
2023-11-20 12:40       ` Jonathan Cameron
2023-11-27  3:02         ` Andrew Jeffery
2023-11-03  6:15 ` [PATCH 09/10] ipmi: kcs_bmc: Add module_kcs_bmc_driver() Andrew Jeffery
2023-11-03 15:06   ` Jonathan Cameron
2023-11-03  6:15 ` [PATCH 10/10] ipmi: kcs_bmc: Add subsystem kerneldoc Andrew Jeffery
2023-11-03 15:12   ` Jonathan Cameron [this message]
2023-11-06  0:05     ` Andrew Jeffery

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=20231103151230.0000161e@Huawei.com \
    --to=jonathan.cameron@huawei.com \
    --cc=aladyshev22@gmail.com \
    --cc=andrew@codeconstruct.com.au \
    --cc=jk@codeconstruct.com.au \
    --cc=linux-kernel@vger.kernel.org \
    --cc=minyard@acm.org \
    --cc=openipmi-developer@lists.sourceforge.net \
    /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.