.checkpatch.conf - filogic/atf - Gitiles

 #
 # Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
 #
 # Redistributions of source code must retain the above copyright notice, this
 # list of conditions and the following disclaimer.
 #
 # Redistributions in binary form must reproduce the above copyright notice,
 # this list of conditions and the following disclaimer in the documentation
 # and/or other materials provided with the distribution.
 #
 # Neither the name of ARM nor the names of its contributors may be used
 # to endorse or promote products derived from this software without specific
 # prior written permission.
 #
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 #

 #
 # Configure how the Linux checkpatch script should be invoked in the context of
 # the Trusted Firmware source tree.
 #

 # This is not Linux so don't expect a Linux tree!
 --no-tree

 # This clarifes the lines indications in the report.
 #
 # E.g.:
 # Without this option, we have the following output:
 #      #333: FILE: drivers/arm/gic/arm_gic.c:160:
 # So we have 2 lines indications (333 and 160), which is confusing.
 # We only care about the position in the source file.
 #
 # With this option, it becomes:
 #      drivers/arm/gic/arm_gic.c:160:
 --showfile

 # Don't show some messages like the list of ignored types or the suggestion to
 # use "--fix" or report changes to the maintainers.
 --quiet

 #
 # Ignore the following message types, as they don't necessarily make sense in
 # the context of the Trusted Firmware.
 #

 # COMPLEX_MACRO generates false positives.
 --ignore COMPLEX_MACRO

 # Commit messages might contain a Gerrit Change-Id.
 --ignore GERRIT_CHANGE_ID

 # Do not check the format of commit messages, as Github's merge commits do not
 # observe it.
 --ignore GIT_COMMIT_ID

 # FILE_PATH_CHANGES reports this kind of message:
 # "added, moved or deleted file(s), does MAINTAINERS need updating?"
 # We do not use this MAINTAINERS file process in TF.
 --ignore FILE_PATH_CHANGES

 # AVOID_EXTERNS reports this kind of messages:
 # "externs should be avoided in .c files"
 # We don't follow this convention in TF.
 --ignore AVOID_EXTERNS

 # NEW_TYPEDEFS reports this kind of messages:
 # "do not add new typedefs"
 # We allow adding new typedefs in TF.
 --ignore NEW_TYPEDEFS

 # Avoid "Does not appear to be a unified-diff format patch" message
 --ignore NOT_UNIFIED_DIFF

 # VOLATILE reports this kind of messages:
 # "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt"
 # We allow the usage of the volatile keyword in TF.
 --ignore VOLATILE
	#
	# Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
	#
	# Redistribution and use in source and binary forms, with or without
	# modification, are permitted provided that the following conditions are met:
	#
	# Redistributions of source code must retain the above copyright notice, this
	# list of conditions and the following disclaimer.
	#
	# Redistributions in binary form must reproduce the above copyright notice,
	# this list of conditions and the following disclaimer in the documentation
	# and/or other materials provided with the distribution.
	#
	# Neither the name of ARM nor the names of its contributors may be used
	# to endorse or promote products derived from this software without specific
	# prior written permission.
	#
	# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
	# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	# POSSIBILITY OF SUCH DAMAGE.
	#

	#
	# Configure how the Linux checkpatch script should be invoked in the context of
	# the Trusted Firmware source tree.
	#

	# This is not Linux so don't expect a Linux tree!
	--no-tree

	# This clarifes the lines indications in the report.
	#
	# E.g.:
	# Without this option, we have the following output:
	# #333: FILE: drivers/arm/gic/arm_gic.c:160:
	# So we have 2 lines indications (333 and 160), which is confusing.
	# We only care about the position in the source file.
	#
	# With this option, it becomes:
	# drivers/arm/gic/arm_gic.c:160:
	--showfile

	# Don't show some messages like the list of ignored types or the suggestion to
	# use "--fix" or report changes to the maintainers.
	--quiet

	#
	# Ignore the following message types, as they don't necessarily make sense in
	# the context of the Trusted Firmware.
	#

	# COMPLEX_MACRO generates false positives.
	--ignore COMPLEX_MACRO

	# Commit messages might contain a Gerrit Change-Id.
	--ignore GERRIT_CHANGE_ID

	# Do not check the format of commit messages, as Github's merge commits do not
	# observe it.
	--ignore GIT_COMMIT_ID

	# FILE_PATH_CHANGES reports this kind of message:
	# "added, moved or deleted file(s), does MAINTAINERS need updating?"
	# We do not use this MAINTAINERS file process in TF.
	--ignore FILE_PATH_CHANGES

	# AVOID_EXTERNS reports this kind of messages:
	# "externs should be avoided in .c files"
	# We don't follow this convention in TF.
	--ignore AVOID_EXTERNS

	# NEW_TYPEDEFS reports this kind of messages:
	# "do not add new typedefs"
	# We allow adding new typedefs in TF.
	--ignore NEW_TYPEDEFS

	# Avoid "Does not appear to be a unified-diff format patch" message
	--ignore NOT_UNIFIED_DIFF

	# VOLATILE reports this kind of messages:
	# "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt"
	# We allow the usage of the volatile keyword in TF.
	--ignore VOLATILE