| Message ID | 20240208162748.111120-1-vincenzo.mezzela@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: staging: fix typo in docs | expand |
Vincenzo Mezzela <vincenzo.mezzela@gmail.com> writes: So your fix is fine, but I need to point out a couple of things with the changelog. > This patch resolves a spelling error in the documentation found > with codespell. If you look at Documentation/process/submitting-patches.rst, you'll see that changelog text should be phrased in the imperative mode; no "this patch". I tend not to be too fussy about that, but some maintainers will reject a patch out of hand for that, so it's a good thing to learn to avoid. > It is submitted as part of my application to the "Linux Kernel Bug > Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel > Foundation. This is interesting (I'd never heard of the Linux Kernel Foundation), but it's not really relevant for the kernel development history. If you want to put this kind of information in a submission, put it after the "---" line so that it doesn't end up being committed with the patch. > Signed-off-by: Vincenzo Mezzela <vincenzo.mezzela@gmail.com> I have gone ahead and fixed up these things and applied your two patches, thanks. jon
Il giorno gio 8 feb 2024 alle ore 23:42 Jonathan Corbet <corbet@lwn.net> ha scritto: Hi Jon, > > Vincenzo Mezzela <vincenzo.mezzela@gmail.com> writes: > > So your fix is fine, but I need to point out a couple of things with the > changelog. > > > This patch resolves a spelling error in the documentation found > > with codespell. > > If you look at Documentation/process/submitting-patches.rst, you'll see > that changelog text should be phrased in the imperative mode; no "this > patch". I tend not to be too fussy about that, but some maintainers > will reject a patch out of hand for that, so it's a good thing to learn > to avoid. > > > It is submitted as part of my application to the "Linux Kernel Bug > > Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel > > Foundation. > > This is interesting (I'd never heard of the Linux Kernel Foundation), My mistake, I should have written LInux Foundation. > but it's not really relevant for the kernel development history. If you > want to put this kind of information in a submission, put it after the > "---" line so that it doesn't end up being committed with the patch. Thank you very much for the corrections, I'm still in the process of learning. I will pay more attention next time :) > > > Signed-off-by: Vincenzo Mezzela <vincenzo.mezzela@gmail.com> > > I have gone ahead and fixed up these things and applied your two > patches, thanks. Thank you, Vincenzo
diff --git a/Documentation/staging/rpmsg.rst b/Documentation/staging/rpmsg.rst index dba3e5f65612..3713adaa1608 100644 --- a/Documentation/staging/rpmsg.rst +++ b/Documentation/staging/rpmsg.rst @@ -157,7 +157,7 @@ Returns 0 on success and an appropriate error value on failure. int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst) -sends a message across to the remote processor from a given endoint, +sends a message across to the remote processor from a given endpoint, to a destination address provided by the user. The user should specify the channel, the data it wants to send,
This patch resolves a spelling error in the documentation found with codespell. It is submitted as part of my application to the "Linux Kernel Bug Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel Foundation. Signed-off-by: Vincenzo Mezzela <vincenzo.mezzela@gmail.com> --- Documentation/staging/rpmsg.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)