1 GIT-PBCHK(1ONBLD)                                            GIT-PBCHK(1ONBLD)
   2 
   3 
   4 
   5 
   6 
   7 
   8 NAME
   9        git-pbchk - nits and pre-putback checks for git
  10 
  11 
  12 SYNOPSIS
  13        git-pbchk [-b branch]
  14 
  15 
  16        git-nits [-b branch]
  17 
  18 
  19 DESCRIPTION
  20        Check your workspace for common nits and putback-ending mistakes, a
  21        simple set of checks are run over various parts of your workspace and
  22        errors encountered are reported, all of which should, generally, be
  23        fixed.
  24 
  25 
  26        Comment format
  27               Check that putback comments follow the prescribed format (only
  28               run for pbchk)
  29 
  30 
  31        Copyrights
  32               Check that each source file contains a copyright notice for the
  33               current year. You don't need to fix this if you, the potential
  34               new copyright holder, chooses not to
  35 
  36 
  37        C style
  38               Check that C source files conform to the Illumos C style rules
  39 
  40 
  41        Header check
  42               Check that C header files conform to the Illumos header style
  43               rules (in addition to the general C rules)
  44 
  45 
  46        Java style
  47               Check that Java source files conform to the Illumos Java style
  48               rules (which differ from the traditionally recommended Java
  49               style)
  50 
  51 
  52        SCCS Keywords
  53               Check that no source files contain unexpanded SCCS keywords. It
  54               is possible that this check may false positive on certain
  55               inputs. It is generally obvious when this is the case.
  56 
  57 
  58               This check does not check for expanded SCCS keywords, though the
  59               common 'ident'-style lines should be removed regardless of
  60               whether they are expanded.
  61 
  62 
  63        Mapfile check
  64               Check that linker mapfiles contain a comment directing anyone
  65               editing to read the directions in usr/lib/README.mapfiles.
  66 
  67 
  68 OPTIONS
  69        -b branch:
  70 
  71 
  72               Compare the current workspace to /branch/ for the purposes of
  73               generating file and comment lists.
  74 
  75 
  76               If this option is not specified an attempt is made to determine
  77               this automatically, if the git branch configuration contains
  78               this information.
  79 
  80 
  81               If no branch is specified and none can be determined
  82               automatically origin/master is used.
  83 
  84 
  85 FILES
  86        git nits and git pbchk support NOT files of the form used by Cadmium
  87        with Mercurial. These are looked for in $CODEMGR_WS/.git/ and in
  88        $CODEMGR_WS/exception_lists/ as normal. The files are named after the
  89        check from which they exclude files.
  90 
  91 
  92        o   copyright.NOT: exclude files listed from copyright checking
  93 
  94 
  95        o   cstyle.NOT: exclude files from the C style check
  96 
  97 
  98        o   hdrchk.NOT: exclude files from the C header style check
  99 
 100 
 101        o   keywords.NOT: exclude files from the SCCS keywords check
 102 
 103 
 104        o   mapfilechk.NOT: exclude files from the linker mapfile check
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112                                 April 23, 2015               GIT-PBCHK(1ONBLD)