From: Lee Jones <lee.jones@linaro.org>
To: Wolfram Sang <wsa@kernel.org>
Cc: arnd@arndb.de, gregkh@linuxfoundation.org,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 06/10] misc: eeprom: eeprom_93cx6: Repair function arg descriptions
Date: Mon, 29 Jun 2020 09:46:59 +0100 [thread overview]
Message-ID: <20200629084659.GI177734@dell> (raw)
In-Reply-To: <20200629082037.GA1063@kunai>
On Mon, 29 Jun 2020, Wolfram Sang wrote:
>
> > > > @@ -270,7 +270,7 @@ EXPORT_SYMBOL_GPL(eeprom_93cx6_readb);
> > > > * @eeprom: Pointer to eeprom structure
> > > > * @byte: Index from where we should start reading
> > > > * @data: target pointer where the information will have to be stored
> > > > - * @words: Number of bytes that should be read.
> > > > + * @bytes: Number of bytes that should be read.
> > >
> > > Now we have 'byte' and 'bytes' here as arguments which is confusing. I
> > > think renaming 'words' into 'num_bytes' would be even better.
> >
> > I await your patch with bated breath. :)
>
> ? You are touching it already, why a second patch?
Because it's a different change. One that's orthogonal to this set,
which is designed simply to ensure the documentation matches reality.
The author decided on this (less than ideal [in our humble opinion])
nomenclature from the function's inception back in 2013. Maybe there
are good reasons for it to be this way. Either way, it might require
a dialogue. For this set I'd rather stick to the script.
That said, I genuinely don't mind drafting a patch to fix this. If I
am to do so, it would also be as part as a subsequent effort.
You or me - your call. Happy either way.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
next prev parent reply other threads:[~2020-06-29 20:50 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-26 13:05 [PATCH 00/10] Fix a bunch of W=1 warnings in Misc Lee Jones
2020-06-26 13:05 ` [PATCH 01/10] misc: c2port: core: Ensure source size does not equal destination size in strncpy() Lee Jones
2020-06-26 13:15 ` Rodolfo Giometti
2020-07-13 19:10 ` Geert Uytterhoeven
2020-07-14 7:46 ` Lee Jones
2020-07-14 7:52 ` Geert Uytterhoeven
2020-07-14 8:01 ` Lee Jones
2020-07-14 8:02 ` Geert Uytterhoeven
2020-06-26 13:05 ` [PATCH 02/10] misc: ti-st: st_core: Tidy-up bespoke commentry Lee Jones
2020-06-26 14:05 ` Arnd Bergmann
2020-06-26 13:05 ` [PATCH 03/10] misc: ti-st: st_kim: " Lee Jones
2020-06-26 14:06 ` Arnd Bergmann
2020-06-26 13:05 ` [PATCH 04/10] misc: lkdtm: bugs: At least try to use popuated variable Lee Jones
2020-06-26 14:37 ` Arnd Bergmann
2020-06-26 15:26 ` Kees Cook
2020-06-26 13:05 ` [PATCH 05/10] misc: lkdtm: Always provide prototype for lkdtm_DOUBLE_FAULT() Lee Jones
2020-06-26 14:37 ` Arnd Bergmann
2020-06-26 15:23 ` Kees Cook
2020-06-26 13:05 ` [PATCH 06/10] misc: eeprom: eeprom_93cx6: Repair function arg descriptions Lee Jones
2020-06-26 14:38 ` Arnd Bergmann
2020-06-27 20:33 ` Wolfram Sang
2020-06-29 8:14 ` Lee Jones
2020-06-29 8:20 ` Wolfram Sang
2020-06-29 8:46 ` Lee Jones [this message]
2020-06-26 13:05 ` [PATCH 07/10] misc: mic: vop: vop_main: Remove set but unused variable 'ret' Lee Jones
2020-06-26 14:39 ` Arnd Bergmann
2020-06-26 15:29 ` Lee Jones
2020-06-26 18:38 ` Arnd Bergmann
2020-06-26 13:05 ` [PATCH 08/10] misc: cb710: sgbuf2: Add missing documentation for cb710_sg_dwiter_write_next_block()'s 'data' arg Lee Jones
2020-06-26 14:39 ` Arnd Bergmann
2020-06-26 16:46 ` Michał Mirosław
2020-06-26 13:05 ` [PATCH 09/10] misc: habanalabs: irq: Add missing struct identifier for 'struct hl_eqe_work' Lee Jones
2020-06-26 13:45 ` Oded Gabbay
2020-06-26 13:46 ` Oded Gabbay
2020-06-26 13:05 ` [PATCH 10/10] misc: pti: Fix documentation for bit-rotted function pti_tty_driver_write() Lee Jones
2020-06-26 14:40 ` Arnd Bergmann
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=20200629084659.GI177734@dell \
--to=lee.jones@linaro.org \
--cc=arnd@arndb.de \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wsa@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;
as well as URLs for NNTP newsgroup(s).