Print this page
9803 pbchk could use a -c option
9825 pbchk -b option should be -p
@@ -8,106 +8,90 @@
NAME
git-pbchk - nits and pre-putback checks for git
SYNOPSIS
- git-pbchk [-b branch]
+ git-pbchk [-c check] [-p branch] [file...]
- git-nits [-b branch]
+ git-nits [-c check] [-p branch] [file...]
+OPTIONS
+ -c check:
+
+ Run the specific check, as named below. In this mode,
+ individual files can be provided to check.
+
+ -p branch:
+
+ Compare the current workspace to the parent branch for the
+ purposes of generating file and comment lists.
+
+ If this option is not specified an attempt is made to determine
+ this automatically, if the git branch configuration contains
+ this information.
+
+ If no branch is specified and none can be determined
+ automatically origin/master is used.
+
DESCRIPTION
Check your workspace for common nits and putback-ending mistakes, a
simple set of checks are run over various parts of your workspace and
errors encountered are reported, all of which should, generally, be
fixed.
-
- Comment format
+ Comment format [comchk]
Check that putback comments follow the prescribed format (only
run for pbchk)
-
- Copyrights
+ Copyrights [copyright]
Check that each source file contains a copyright notice for the
current year. You don't need to fix this if you, the potential
new copyright holder, chooses not to
-
- C style
+ C style [cstyle]
Check that C source files conform to the Illumos C style rules
-
- Header check
+ Header check [hdrchk]
Check that C header files conform to the Illumos header style
rules (in addition to the general C rules)
-
- Java style
+ Java style [jstyle]
Check that Java source files conform to the Illumos Java style
rules (which differ from the traditionally recommended Java
style)
-
- SCCS Keywords
+ SCCS Keywords [keywords]
Check that no source files contain unexpanded SCCS keywords. It
is possible that this check may false positive on certain
inputs. It is generally obvious when this is the case.
-
This check does not check for expanded SCCS keywords, though the
common 'ident'-style lines should be removed regardless of
whether they are expanded.
+ Man page check [manlint]
+ Check for problems with man pages.
- Mapfile check
+ Mapfile check [mapfilechk]
Check that linker mapfiles contain a comment directing anyone
editing to read the directions in usr/lib/README.mapfiles.
+ Whitespace check [wscheck]
+ Check for whitespace issues such as mixed tabs/spaces in source
+ files.
-OPTIONS
- -b branch:
-
-
- Compare the current workspace to /branch/ for the purposes of
- generating file and comment lists.
-
-
- If this option is not specified an attempt is made to determine
- this automatically, if the git branch configuration contains
- this information.
-
-
- If no branch is specified and none can be determined
- automatically origin/master is used.
-
-
FILES
- git nits and git pbchk support NOT files of the form used by Cadmium
- with Mercurial. These are looked for in $CODEMGR_WS/.git/ and in
- $CODEMGR_WS/exception_lists/ as normal. The files are named after the
- check from which they exclude files.
+ Exception lists can be used to exclude certain files from checking,
+ named after the specific check. They can be found in
+ $CODEMGR_WS/exception_lists/, or optionally under $CODEMGR_WS/.git/,
+ where they must be suffixed .NOT.
- o copyright.NOT: exclude files listed from copyright checking
- o cstyle.NOT: exclude files from the C style check
- o hdrchk.NOT: exclude files from the C header style check
- o keywords.NOT: exclude files from the SCCS keywords check
-
-
- o mapfilechk.NOT: exclude files from the linker mapfile check
-
-
-
-
-
-
-
-
- April 23, 2015 GIT-PBCHK(1ONBLD)
+ September 4, 2018 GIT-PBCHK(1ONBLD)