.checkpatch.conf

   1 #
   2 # Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are met:
   6 #
   7 # Redistributions of source code must retain the above copyright notice, this
   8 # list of conditions and the following disclaimer.
   9 #
  10 # Redistributions in binary form must reproduce the above copyright notice,
  11 # this list of conditions and the following disclaimer in the documentation
  12 # and/or other materials provided with the distribution.
  13 #
  14 # Neither the name of ARM nor the names of its contributors may be used
  15 # to endorse or promote products derived from this software without specific
  16 # prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 # POSSIBILITY OF SUCH DAMAGE.
  29 #
  30
  31 #
  32 # Configure how the Linux checkpatch script should be invoked in the context of
  33 # the Trusted Firmware source tree.
  34 #
  35
  36 # This is not Linux so don't expect a Linux tree!
  37 --no-tree
  38
  39 # The Linux kernel expects the SPDX license tag in the first line of each file.
  40 # We don't follow this in the Trusted Firmware.
  41 --ignore SPDX_LICENSE_TAG
  42
  43 # This clarifes the lines indications in the report.
  44 #
  45 # E.g.:
  46 # Without this option, we have the following output:
  47 #      #333: FILE: drivers/arm/gic/arm_gic.c:160:
  48 # So we have 2 lines indications (333 and 160), which is confusing.
  49 # We only care about the position in the source file.
  50 #
  51 # With this option, it becomes:
  52 #      drivers/arm/gic/arm_gic.c:160:
  53 --showfile
  54
  55 # Don't show some messages like the list of ignored types or the suggestion to
  56 # use "--fix" or report changes to the maintainers.
  57 --quiet
  58
  59 #
  60 # Ignore the following message types, as they don't necessarily make sense in
  61 # the context of the Trusted Firmware.
  62 #
  63
  64 # COMPLEX_MACRO generates false positives.
  65 --ignore COMPLEX_MACRO
  66
  67 # Commit messages might contain a Gerrit Change-Id.
  68 --ignore GERRIT_CHANGE_ID
  69
  70 # Do not check the format of commit messages, as Github's merge commits do not
  71 # observe it.
  72 --ignore GIT_COMMIT_ID
  73
  74 # FILE_PATH_CHANGES reports this kind of message:
  75 # "added, moved or deleted file(s), does MAINTAINERS need updating?"
  76 # We do not use this MAINTAINERS file process in TF.
  77 --ignore FILE_PATH_CHANGES
  78
  79 # AVOID_EXTERNS reports this kind of messages:
  80 # "externs should be avoided in .c files"
  81 # We don't follow this convention in TF.
  82 --ignore AVOID_EXTERNS
  83
  84 # NEW_TYPEDEFS reports this kind of messages:
  85 # "do not add new typedefs"
  86 # We allow adding new typedefs in TF.
  87 --ignore NEW_TYPEDEFS
  88
  89 # Avoid "Does not appear to be a unified-diff format patch" message
  90 --ignore NOT_UNIFIED_DIFF
  91
  92 # VOLATILE reports this kind of messages:
  93 # "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt"
  94 # We allow the usage of the volatile keyword in TF.
  95 --ignore VOLATILE