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