Print this page
9803 pbchk could use a -c option
9825 pbchk -b option should be -p
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/tools/scripts/git-pbchk.1onbld.man.txt
+++ new/usr/src/tools/scripts/git-pbchk.1onbld.man.txt
1 1 GIT-PBCHK(1ONBLD) GIT-PBCHK(1ONBLD)
2 2
|
↓ open down ↓ |
2 lines elided |
↑ open up ↑ |
3 3
4 4
5 5
6 6
7 7
8 8 NAME
9 9 git-pbchk - nits and pre-putback checks for git
10 10
11 11
12 12 SYNOPSIS
13 - git-pbchk [-b branch]
13 + git-pbchk [-c check] [-p branch] [file...]
14 14
15 15
16 - git-nits [-b branch]
16 + git-nits [-c check] [-p branch] [file...]
17 17
18 18
19 +OPTIONS
20 + -c check:
21 +
22 + Run the specific check, as named below. In this mode,
23 + individual files can be provided to check.
24 +
25 + -p branch:
26 +
27 + Compare the current workspace to the parent branch for the
28 + purposes of generating file and comment lists.
29 +
30 + If this option is not specified an attempt is made to determine
31 + this automatically, if the git branch configuration contains
32 + this information.
33 +
34 + If no branch is specified and none can be determined
35 + automatically origin/master is used.
36 +
19 37 DESCRIPTION
20 38 Check your workspace for common nits and putback-ending mistakes, a
21 39 simple set of checks are run over various parts of your workspace and
22 40 errors encountered are reported, all of which should, generally, be
23 41 fixed.
24 42
25 -
26 - Comment format
43 + Comment format [comchk]
27 44 Check that putback comments follow the prescribed format (only
28 45 run for pbchk)
29 46
30 -
31 - Copyrights
47 + Copyrights [copyright]
32 48 Check that each source file contains a copyright notice for the
33 49 current year. You don't need to fix this if you, the potential
34 50 new copyright holder, chooses not to
35 51
36 -
37 - C style
52 + C style [cstyle]
38 53 Check that C source files conform to the Illumos C style rules
39 54
40 -
41 - Header check
55 + Header check [hdrchk]
42 56 Check that C header files conform to the Illumos header style
43 57 rules (in addition to the general C rules)
44 58
45 -
46 - Java style
59 + Java style [jstyle]
47 60 Check that Java source files conform to the Illumos Java style
48 61 rules (which differ from the traditionally recommended Java
49 62 style)
50 63
51 -
52 - SCCS Keywords
64 + SCCS Keywords [keywords]
53 65 Check that no source files contain unexpanded SCCS keywords. It
54 66 is possible that this check may false positive on certain
55 67 inputs. It is generally obvious when this is the case.
56 68
57 -
58 69 This check does not check for expanded SCCS keywords, though the
59 70 common 'ident'-style lines should be removed regardless of
60 71 whether they are expanded.
61 72
73 + Man page check [manlint]
74 + Check for problems with man pages.
62 75
63 - Mapfile check
76 + Mapfile check [mapfilechk]
64 77 Check that linker mapfiles contain a comment directing anyone
65 78 editing to read the directions in usr/lib/README.mapfiles.
66 79
80 + Whitespace check [wscheck]
81 + Check for whitespace issues such as mixed tabs/spaces in source
82 + files.
67 83
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 84 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.
85 + Exception lists can be used to exclude certain files from checking,
86 + named after the specific check. They can be found in
87 + $CODEMGR_WS/exception_lists/, or optionally under $CODEMGR_WS/.git/,
88 + where they must be suffixed .NOT.
90 89
91 90
92 - o copyright.NOT: exclude files listed from copyright checking
93 91
94 92
95 - o cstyle.NOT: exclude files from the C style check
96 93
97 94
98 - o hdrchk.NOT: exclude files from the C header style check
99 95
100 96
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 -
113 - April 23, 2015 GIT-PBCHK(1ONBLD)
97 + September 4, 2018 GIT-PBCHK(1ONBLD)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX