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