scripts: enhance the get maintainer error message
[dpdk.git] / devtools / get-maintainer.sh
1 #!/bin/sh
2
3 #   BSD LICENSE
4 #
5 #   Copyright(c) 2017 Intel Corporation. All rights reserved.
6 #   All rights reserved.
7 #
8 #   Redistribution and use in source and binary forms, with or without
9 #   modification, are permitted provided that the following conditions
10 #   are met:
11 #
12 #     * Redistributions of source code must retain the above copyright
13 #       notice, this list of conditions and the following disclaimer.
14 #     * Redistributions in binary form must reproduce the above copyright
15 #       notice, this list of conditions and the following disclaimer in
16 #       the documentation and/or other materials provided with the
17 #       distribution.
18 #     * Neither the name of Intel Corporation nor the names of its
19 #       contributors may be used to endorse or promote products derived
20 #       from this software without specific prior written permission.
21 #
22 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34
35 # Load config options:
36 # - DPDK_GETMAINTAINER_PATH
37 . $(dirname $(readlink -e $0))/load-devel-config
38
39 options="--no-git-fallback"
40 options="$options --no-rolestats"
41
42 print_usage () {
43         cat <<- END_OF_HELP
44         usage: $(basename $0) <patch>
45
46         The DPDK_GETMAINTAINER_PATH variable should be set to the full path to
47         the get_maintainer.pl script located in Linux kernel sources. Example:
48         DPDK_GETMAINTAINER_PATH=~/linux/scripts/get_maintainer.pl
49
50         Also refer to devtools/load-devel-config to store your configuration.
51         END_OF_HELP
52 }
53
54 # Requires DPDK_GETMAINTAINER_PATH devel config option set
55 if [ ! -x "$DPDK_GETMAINTAINER_PATH" ] ; then
56         print_usage >&2
57         echo
58         echo 'Cannot execute DPDK_GETMAINTAINER_PATH' >&2
59         exit 1
60 fi
61
62 FILES="COPYING CREDITS Kbuild"
63 FOLDERS="Documentation arch include fs init ipc kernel scripts"
64
65 # Kernel script checks for some files and folders to run
66 workaround () {
67         for f in $FILES; do
68                 if [ ! -f $f ]; then touch $f; fi
69         done
70
71         for d in $FOLDERS; do
72                 if [ ! -d $d ]; then mkdir $d; fi
73         done
74 }
75
76 fix_workaround () {
77         for f in $FILES; do if [ -f $f ]; then rm -f $f; fi; done
78         for d in $FOLDERS; do if [ -d $d ]; then rmdir $d; fi; done
79 }
80
81 # clean workaround on exit
82 trap fix_workaround EXIT
83
84 workaround
85 $DPDK_GETMAINTAINER_PATH $options $@
86 # fix_workaround called on exit by trap