Home | History | Annotate | Download | only in arm-trusted-firmware 
      1 #
      2 # Copyright (c) 2016, 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 # This clarifes the lines indications in the report.
     40 #
     41 # E.g.:
     42 # Without this option, we have the following output:
     43 #      #333: FILE: drivers/arm/gic/arm_gic.c:160:
     44 # So we have 2 lines indications (333 and 160), which is confusing.
     45 # We only care about the position in the source file.
     46 #
     47 # With this option, it becomes:
     48 #      drivers/arm/gic/arm_gic.c:160:
     49 --showfile
     50 
     51 #
     52 # Ignore the following message types, as they don't necessarily make sense in
     53 # the context of the Trusted Firmware.
     54 #
     55 
     56 # COMPLEX_MACRO generates false positives.
     57 --ignore COMPLEX_MACRO
     58 
     59 # Commit messages might contain a Gerrit Change-Id.
     60 --ignore GERRIT_CHANGE_ID
     61 
     62 # Do not check the format of commit messages, as Github's merge commits do not
     63 # observe it.
     64 --ignore GIT_COMMIT_ID
     65 
     66 # FILE_PATH_CHANGES reports this kind of message:
     67 # "added, moved or deleted file(s), does MAINTAINERS need updating?"
     68 # We do not use this MAINTAINERS file process in TF.
     69 --ignore FILE_PATH_CHANGES
     70 
     71 # AVOID_EXTERNS reports this kind of messages:
     72 # "externs should be avoided in .c files"
     73 # We don't follow this convention in TF.
     74 --ignore AVOID_EXTERNS
     75 
     76 # NEW_TYPEDEFS reports this kind of messages:
     77 # "do not add new typedefs"
     78 # We allow adding new typedefs in TF.
     79 --ignore NEW_TYPEDEFS
     80 
     81 # VOLATILE reports this kind of messages:
     82 # "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt"
     83 # We allow the usage of the volatile keyword in TF.
     84 --ignore VOLATILE
     85