GIT-PBCHK(1ONBLD) illumos Build Tools GIT-PBCHK(1ONBLD)

NAME


git-pbchk, git-nits - nits and pre-putback checks for git

SYNOPSIS


git-pbchk -l
git-pbchk [-c check...] [-p branch]
git-nits [-c check...] [-p branch] [file...]

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.

As these command names start with `git-' they can also be run by git(1) as
subcommands:

$ git pbchk

OPTIONS


-c check
Run the specific check, as named below. In this mode, individual
files can be provided to check. Multiple -c options can be
supplied, and will run the named checks in the order given on the
command line.

-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.

-l Print a list of the checks that can be used with -c, with a short
description of each one.

CHECKS


Comment format: comchk
Check that putback comments follow the prescribed format (only run
for pbchk).

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: cstyle
Check that C source files conform to the illumos C style rules

Header check: hdrchk
Check that C header files conform to the illumos header style rules
(in addition to the general C rules).

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: 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: mapfilechk
Check that linker mapfiles contain a comment directing anyone
editing to read the directions in usr/lib/README.mapfiles.

Shell script check: shelllint
Check for problems with shell scripts.

Package manifest formatting: pkgfmt
Check package manifests for common errors.

Windows special filename check winnames
Check for filenames which would prevent you from checking out
illumos-gate on a Windows system.

Whitespace check: wscheck
Check for whitespace issues such as mixed tabs/spaces in source
files.

Committed symlinks check: symlinks
Report if there are any symlinks checked into your change; they are
not allowed by illumos policy.

FILES


Exception lists can be used to exclude certain files from checks, named
after the specific check. They can be found in
$CODEMGR_WS/exception_lists, or optionally under $CODEMGR_WS/.git/info/,
where they must be suffixed .NOT.

SEE ALSO


git(1)

illumos February 1, 2024 illumos