usr/src/tools/onbld/Checks/ManLint.py

   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
  33 import sys
  34 from onbld.Checks.ProcessCheck import processcheck
  35
  36 def 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
  46         if not filename:
  47                 filename = fh.name
  48
  49         ret, tmpfile = processcheck('mandoc', options, fh, output)
  50
  51         if tmpfile:
  52                 for line in tmpfile:
  53                         line = line.replace('<stdin>', filename)
  54                         output.write(line)
  55
  56                 tmpfile.close()
  57         return ret