mtd: mtd-abi: Don't use C++ comments
diff mbox series

Message ID 20190620155505.27036-1-natechancellor@gmail.com
State Accepted
Headers show
Series
  • mtd: mtd-abi: Don't use C++ comments
Related show

Commit Message

Nathan Chancellor June 20, 2019, 3:55 p.m. UTC
When compiled standalone after commit b91976b7c0e3 ("kbuild:
compile-test UAPI headers to ensure they are self-contained"),
a warning about the C++ comments appears:

  In file included from usr/include/mtd/mtd-user.hdrtest.c:1:
  In file included from ./usr/include/mtd/mtd-user.h:25:
  ./usr/include/mtd/mtd-abi.h:116:28: warning: // comments are not
  allowed in this language [-Wcomment]
  #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
                                          ^
  1 warning generated.

Replace them with standard C comments so this warning no longer occurs.

Signed-off-by: Nathan Chancellor <natechancellor@gmail.com>
---
 include/uapi/mtd/mtd-abi.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Nick Desaulniers June 20, 2019, 7:56 p.m. UTC | #1
On Thu, Jun 20, 2019 at 8:55 AM Nathan Chancellor
<natechancellor@gmail.com> wrote:
>
> When compiled standalone after commit b91976b7c0e3 ("kbuild:
> compile-test UAPI headers to ensure they are self-contained"),
> a warning about the C++ comments appears:
>
>   In file included from usr/include/mtd/mtd-user.hdrtest.c:1:
>   In file included from ./usr/include/mtd/mtd-user.h:25:
>   ./usr/include/mtd/mtd-abi.h:116:28: warning: // comments are not
>   allowed in this language [-Wcomment]
>   #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
>                                           ^
>   1 warning generated.
>
> Replace them with standard C comments so this warning no longer occurs.

Should there be a fixes by tag?
Nathan Chancellor June 20, 2019, 8:15 p.m. UTC | #2
On Thu, Jun 20, 2019 at 12:56:58PM -0700, Nick Desaulniers wrote:
> On Thu, Jun 20, 2019 at 8:55 AM Nathan Chancellor
> <natechancellor@gmail.com> wrote:
> >
> > When compiled standalone after commit b91976b7c0e3 ("kbuild:
> > compile-test UAPI headers to ensure they are self-contained"),
> > a warning about the C++ comments appears:
> >
> >   In file included from usr/include/mtd/mtd-user.hdrtest.c:1:
> >   In file included from ./usr/include/mtd/mtd-user.h:25:
> >   ./usr/include/mtd/mtd-abi.h:116:28: warning: // comments are not
> >   allowed in this language [-Wcomment]
> >   #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
> >                                           ^
> >   1 warning generated.
> >
> > Replace them with standard C comments so this warning no longer occurs.
> 
> Should there be a fixes by tag?
> -- 
> Thanks,
> ~Nick Desaulniers

Normally, I would have added one but this issue has been present since
the beginning of git history. According to Thomas Gleixner's pre-git
history tree, it would be:

Fixes: 7df80b4c8964 ("MTD core include and device code cleanup")

but since that hash doesn't exist in the normal git history, I don't
think it is worth adding. Of course, if the maintainers want to add it,
I won't object.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/tglx/history.git

Cheers,
NAthan
Nick Desaulniers June 20, 2019, 8:29 p.m. UTC | #3
On Thu, Jun 20, 2019 at 1:15 PM Nathan Chancellor
<natechancellor@gmail.com> wrote:
>
> On Thu, Jun 20, 2019 at 12:56:58PM -0700, Nick Desaulniers wrote:
> > Should there be a fixes by tag?
>
> Normally, I would have added one but this issue has been present since
> the beginning of git history. According to Thomas Gleixner's pre-git
> history tree, it would be:
>
> Fixes: 7df80b4c8964 ("MTD core include and device code cleanup")
>
> but since that hash doesn't exist in the normal git history, I don't
> think it is worth adding. Of course, if the maintainers want to add it,
> I won't object.
>
> [1]: https://git.kernel.org/pub/scm/linux/kernel/git/tglx/history.git

LOL good point; I wonder if the stable maintainers have thoughts on
that or how they expect us to signal that case if we even need to do
anything at all.

Either way, thanks for the patch and
Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>
Greg Kroah-Hartman June 21, 2019, 6:26 a.m. UTC | #4
On Thu, Jun 20, 2019 at 01:29:47PM -0700, Nick Desaulniers wrote:
> On Thu, Jun 20, 2019 at 1:15 PM Nathan Chancellor
> <natechancellor@gmail.com> wrote:
> >
> > On Thu, Jun 20, 2019 at 12:56:58PM -0700, Nick Desaulniers wrote:
> > > Should there be a fixes by tag?
> >
> > Normally, I would have added one but this issue has been present since
> > the beginning of git history. According to Thomas Gleixner's pre-git
> > history tree, it would be:
> >
> > Fixes: 7df80b4c8964 ("MTD core include and device code cleanup")
> >
> > but since that hash doesn't exist in the normal git history, I don't
> > think it is worth adding. Of course, if the maintainers want to add it,
> > I won't object.
> >
> > [1]: https://git.kernel.org/pub/scm/linux/kernel/git/tglx/history.git
> 
> LOL good point; I wonder if the stable maintainers have thoughts on
> that or how they expect us to signal that case if we even need to do
> anything at all.

If you want it applied "since the beginning of time", then just do:

Cc: <stable@vger.kernel.org> # 2.6.0+

or some such marking.

thanks,

greg k-h

Patch
diff mbox series

diff --git a/include/uapi/mtd/mtd-abi.h b/include/uapi/mtd/mtd-abi.h
index aff5b5e59845..3fe9237f723a 100644
--- a/include/uapi/mtd/mtd-abi.h
+++ b/include/uapi/mtd/mtd-abi.h
@@ -113,11 +113,11 @@  struct mtd_write_req {
 #define MTD_CAP_NVRAM		(MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
 
 /* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */
-#define MTD_NANDECC_OFF		0	// Switch off ECC (Not recommended)
-#define MTD_NANDECC_PLACE	1	// Use the given placement in the structure (YAFFS1 legacy mode)
-#define MTD_NANDECC_AUTOPLACE	2	// Use the default placement scheme
-#define MTD_NANDECC_PLACEONLY	3	// Use the given placement in the structure (Do not store ecc result on read)
-#define MTD_NANDECC_AUTOPL_USR 	4	// Use the given autoplacement scheme rather than using the default
+#define MTD_NANDECC_OFF		0	/* Switch off ECC (Not recommended) */
+#define MTD_NANDECC_PLACE	1	/* Use the given placement in the structure (YAFFS1 legacy mode) */
+#define MTD_NANDECC_AUTOPLACE	2	/* Use the default placement scheme */
+#define MTD_NANDECC_PLACEONLY	3	/* Use the given placement in the structure (Do not store ecc result on read) */
+#define MTD_NANDECC_AUTOPL_USR	4	/* Use the given autoplacement scheme rather than using the default */
 
 /* OTP mode selection */
 #define MTD_OTP_OFF		0