Skip to contentSkip to conversation

checkpatch query regarding .c and .h files..

DISCUSSION Valdis Klētnieks 2 participants 2 messages Jun 2, 2019

lore
Share & tools
lore
#0 lore raw

scripts/checkpatch.pl contains this code near line 3070:

                               if ($realfile =~ /\.(h|s|S)$/) {
                                        $comment = '/*';
                                } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
                                        $comment = '//';
                                } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
                                        $comment = '#';
                                } elsif ($realfile =~ /\.rst$/) {
                                        $comment = '..';
                                }

Was there a specific reason why .h files have /* */ and .c files have C89 // on the SPDX comment line?

Would anybody like a patch that fixed checkpatch to allow either flavor on .c and .h files? (I know I would, I just blew close to an hour trying to figure out why it whined about a SPDX in a .h file I'm getting ready to upstream...)

#1 lore raw
Quoted 12 lines · Valdis Klētnieks

scripts/checkpatch.pl contains this code near line 3070:

                               if ($realfile =~ /\.(h|s|S)$/) {
                                        $comment = '/*';
                                } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
                                        $comment = '//';
                                } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
                                        $comment = '#';
                                } elsif ($realfile =~ /\.rst$/) {
                                        $comment = '..';
                                }
Quoted 6 lines

Was there a specific reason why .h files have /* */ and .c files have C89 // on the SPDX comment line?

Would anybody like a patch that fixed checkpatch to allow either flavor on .c and .h files? (I know I would, I just blew close to an hour trying to figure out why it whined about a SPDX in a .h file I'm getting ready to upstream...)

It's described in Documentation/process/license-rules.rst

----------------------------------

2. Style:

The SPDX license identifier is added in form of a comment. The comment style depends on the file type::

C source: // SPDX-License-Identifier: <SPDX License Expression>
C header: /* SPDX-License-Identifier: <SPDX License Expression> */

----------------------------------

It was because old versions of build tools could not handle // in asm files.

It could be changed today because build tool version minimums have been increased.