4 # Copyright (C) 2013 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 # Use array for arguments so that comments can be inline
25 # "...name*(8)" (missing backslash)
28 # "...name(8)" (no asterisk)
31 # "...name(8)*" (asterisk after number)
34 # "...name*\(8)" (only one asterisk before backslash)
35 -e '\w+\*\\\([0-9]*\)'
37 # ":manpage:..." (Sphinx-specific)
42 # Ignore title and then look for faulty references
43 if tail -n +2 $fname | grep -n -E -i "${args[@]}"; then
45 echo "Found faulty man page reference(s) in '$fname'."\
46 'Use syntax "**name**\(number)" instead.'\
47 'Example: **gnt-instance**\(8).'