linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: Wolfram Sang <wsa@kernel.org>
To: Lee Jones <lee.jones@linaro.org>
Cc: linux-kernel@vger.kernel.org, Shawn Guo <shawnguo@kernel.org>,
	Sascha Hauer <s.hauer@pengutronix.de>,
	Pengutronix Kernel Team <kernel@pengutronix.de>,
	Fabio Estevam <festevam@gmail.com>,
	NXP Linux Team <linux-imx@nxp.com>, Marek Vasut <marex@denx.de>,
	linux-i2c@vger.kernel.org, linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header
Date: Fri, 4 Jun 2021 11:06:19 +0200	[thread overview]
Message-ID: <YLntC+Sl8MaFFZw4@shikoro> (raw)
In-Reply-To: <20210604084710.GG2435141@dell>


[-- Attachment #1.1: Type: text/plain, Size: 964 bytes --]


> IMHO, we wouldn't want to foster the impression that it's okay to
> provide a non-determined effort, safe in the knowledge that someone
> will come along later and finish the job for them at a later date.

Right.

The first lesson from that is that maintainers should require
documentation of the fields when they get added. This was my oversight
because it was back then not reported by checkers, probably. I am sorry.
It annoys me, too.

If I notice that someone updates a driver which doc-errors, then I ask
if that could be fixed by this person, too. It usually works. Not for
drivers without attention, of course. But this is why I don't mind
doc-errors to stay.

If this is considered problematic, then I'd suggest to remove the kernel
doc headers like you did, but add a comment like:

 * FIXME: add missing fields and reenable kernel-doc

To make sure, it is obvious even by glimpsing through the code that
there is work needed.

Can we agree on that?


[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[-- Attachment #2: Type: text/plain, Size: 176 bytes --]

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2021-06-04  9:08 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20210520190105.3772683-1-lee.jones@linaro.org>
2021-05-20 19:00 ` [PATCH 01/16] i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout' Lee Jones
2021-05-27  0:21   ` Linus Walleij
2021-05-27 19:28   ` Wolfram Sang
2021-05-28  7:58     ` Lee Jones
2021-05-28  8:00       ` Wolfram Sang
2021-05-28  8:17         ` Lee Jones
2021-05-20 19:00 ` [PATCH 06/16] i2c: busses: i2c-cadence: Fix incorrectly documented 'enum cdns_i2c_slave_mode' Lee Jones
2021-05-24  6:49   ` Michal Simek
2021-05-20 19:00 ` [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Lee Jones
2021-06-03 20:29   ` Wolfram Sang
2021-06-04  8:47     ` Lee Jones
2021-06-04  9:06       ` Wolfram Sang [this message]
2021-06-04  9:32         ` Lee Jones
2021-05-20 19:01 ` [PATCH 11/16] i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data structure Lee Jones
2021-05-21  6:24   ` Vladimir Zapolskiy
2021-05-20 19:01 ` [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Lee Jones
2021-05-20 21:52   ` Heiko Stübner
2021-05-21  6:56     ` Lee Jones
2021-06-19 22:07   ` Heiko Stuebner
2021-05-20 19:01 ` [PATCH 13/16] i2c: busses: i2c-st: Fix copy/paste function misnaming issues Lee Jones
2021-05-21 14:17   ` Alain Volmat
2021-05-21 14:23     ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 14/16] i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function name Lee Jones
2021-05-21 14:20   ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 16/16] i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty' Lee Jones
2021-05-21 14:23   ` Alain Volmat
2021-05-27 19:38     ` Wolfram Sang

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=YLntC+Sl8MaFFZw4@shikoro \
    --to=wsa@kernel.org \
    --cc=festevam@gmail.com \
    --cc=kernel@pengutronix.de \
    --cc=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-imx@nxp.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=marex@denx.de \
    --cc=s.hauer@pengutronix.de \
    --cc=shawnguo@kernel.org \
    --subject='Re: [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header' \
    /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

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).