diff mbox series

spi: spi-mem: Fix typo (of -> or)

Message ID 20221008151459.1421406-1-j.neuschaefer@gmx.net
State Accepted
Commit b994d8f0773cf3b01129c094d00050710f2c422b
Headers show
Series spi: spi-mem: Fix typo (of -> or) | expand

Commit Message

J. Neuschäfer Oct. 8, 2022, 3:14 p.m. UTC
In this instance, "or" makes more sense than "of", so I guess that "or"
was intended and "of" was a typo.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 include/linux/spi/spi-mem.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.35.1

Comments

J. Neuschäfer Oct. 28, 2022, 9:55 a.m. UTC | #1
On Fri, Oct 28, 2022 at 12:00:23PM +0530, Gole, Dhruva wrote:
> Hi Jonathan,
> 
> On 10/8/2022 8:44 PM, Jonathan Neuschäfer wrote:
> > In this instance, "or" makes more sense than "of", so I guess that "or"
> > was intended and "of" was a typo.
> 
> Using "I guess" is generally discouraged in commit messages. Please read up
> the documentation

It is truthful though: I did not write the original comment, and my
change is based on my interpretation of the comment.

> on submitting patches:
> 
> > Describe your changes in imperative mood, e.g. “make xyzzy do frotz”
> instead of “[This patch] makes xyzzy do frotz” or “[I] changed xyzzy to do
> frotz”, as if you are giving orders to the codebase to change its behaviour.

The imperative-mood description is already in the commit title
(or subject line). I am not making a functional change to the code, so
"fix a typo" is really all that is to be said in imperative mood, the
rest is an explanation of why I think this makes sense.

> 
> link: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes


Best regards,
Jonathan
diff mbox series

Patch

diff --git a/include/linux/spi/spi-mem.h b/include/linux/spi/spi-mem.h
index 2ba044d0d5e5b..8e984d75f5b6c 100644
--- a/include/linux/spi/spi-mem.h
+++ b/include/linux/spi/spi-mem.h
@@ -225,7 +225,7 @@  static inline void *spi_mem_get_drvdata(struct spi_mem *mem)
 /**
  * struct spi_controller_mem_ops - SPI memory operations
  * @adjust_op_size: shrink the data xfer of an operation to match controller's
- *		    limitations (can be alignment of max RX/TX size
+ *		    limitations (can be alignment or max RX/TX size
  *		    limitations)
  * @supports_op: check if an operation is supported by the controller
  * @exec_op: execute a SPI memory operation