xref: /illumos-gate/usr/src/tools/onbld/Checks/ManLint.py (revision 37e2cd25d56b334a2403f2540a0b0a1e6a40bcd1)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21
22#
23# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25#
26# Copyright 2014 Garrett D'Amore <garrett@damore.org>
27#
28
29#
30# ManLint, wrap the mandoc lint tool in a pythonic API
31#
32
33import sys
34from onbld.Checks.ProcessCheck import processcheck
35
36def manlint(fh, filename=None, output=sys.stderr, **opts):
37	opttrans = { 'picky': None }
38
39	for x in filter(lambda x: x not in opttrans, opts):
40		raise TypeError('mandoc() got an unexpected keyword '
41				'argument %s' % x)
42
43	options = [opttrans[x] for x in opts if opts[x] and opttrans[x]]
44	options.append('-Tlint')
45	options.append('-Wwarning')
46
47	if not filename:
48		filename = fh.name
49
50	ret, tmpfile = processcheck('mandoc', options, fh, output)
51
52	if tmpfile:
53		for line in tmpfile:
54			line = line.replace('<stdin>', filename)
55			output.write(line)
56
57		tmpfile.close()
58	return ret
59