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
+++ new/usr/src/tools/scripts/git-pbchk.1onbld
1 1 '\" t
2 2 .\"
3 3 .\" This file and its contents are supplied under the terms of the
4 4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
5 5 .\" You may only use this file in accordance with the terms of version
6 6 .\" 1.0 of the CDDL.
↓ open down ↓ |
6 lines elided |
↑ open up ↑ |
7 7 .\"
8 8 .\" A full copy of the text of the CDDL should have accompanied this
9 9 .\" source. A copy of the CDDL is also available via the Internet at
10 10 .\" http://www.illumos.org/license/CDDL.
11 11 .\"
12 12 .\"
13 13 .\" Copyright 2011 Richard Lowe.
14 14 .\" Copyright 2015 Elysium Digital, L.L.C.
15 15 .\"
16 16
17 -.TH "GIT\-PBCHK" "1" "April 23, 2015" "" ""
17 +.TH "GIT\-PBCHK" "1ONBLD" "April 23, 2015" "" ""
18 18
19 19 .SH "NAME"
20 20 \fBgit\-pbchk\fR \- nits and pre\-putback checks for git
21 21
22 22 .SH "SYNOPSIS"
23 23 git\-pbchk [\-b \fIbranch\fR]
24 24
25 25 .P
26 26 git\-nits [\-b \fIbranch\fR]
27 27
28 28 .SH "DESCRIPTION"
29 29 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\.
30 30
31 31 .TP
32 32 Comment format
33 33 Check that putback comments follow the prescribed format (only run for pbchk)
34 34
35 35 .TP
36 36 Copyrights
37 37 Check that each source file contains a copyright notice for the current
38 38 year\. You don't need to fix this if you, the potential new copyright holder, chooses not to
39 39
40 40 .TP
41 41 C style
42 42 Check that C source files conform to the Illumos C style rules
43 43
44 44 .TP
45 45 Header check
46 46 Check that C header files conform to the Illumos header style rules (in addition to the general C rules)
47 47
48 48 .TP
49 49 Java style
50 50 Check that Java source files conform to the Illumos Java style rules (which differ from the traditionally recommended Java style)
51 51
52 52 .TP
53 53 SCCS Keywords
54 54 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\.
55 55
56 56 .IP
57 57 This check does not check for expanded SCCS keywords, though the common \'ident\'\-style lines should be removed regardless of whether they are expanded\.
58 58
59 59 .TP
60 60 Mapfile check
61 61 Check that linker mapfiles contain a comment directing anyone editing to read the directions in \fBusr/lib/README\.mapfiles\fR\.
62 62
63 63 .SH "OPTIONS"
64 64
65 65 .TP
66 66 \fB\-b branch\fR:
67 67
68 68 .IP
69 69 Compare the current workspace to /branch/ for the purposes of generating file and comment lists\.
70 70
71 71 .IP
72 72 If this option is not specified an attempt is made to determine this automatically, if the git branch configuration contains this information\.
73 73
74 74 .IP
75 75 If no branch is specified and none can be determined automatically \fBorigin/master\fR is used\.
76 76
77 77 .SH "FILES"
78 78 \fBgit nits\fR and \fBgit pbchk\fR support NOT files of the form used by Cadmium with Mercurial\. These are looked for in \fB$CODEMGR_WS/\.git/\fR and in \fB$CODEMGR_WS/exception_lists/\fR as normal\. The files are named after the check from which they exclude files\.
79 79
80 80 .IP "\(bu" 4
81 81 \fBcopyright\.NOT\fR: exclude files listed from copyright checking
82 82
83 83 .IP "\(bu" 4
84 84 \fBcstyle\.NOT\fR: exclude files from the C style check
85 85
86 86 .IP "\(bu" 4
87 87 \fBhdrchk\.NOT\fR: exclude files from the C header style check
88 88
89 89 .IP "\(bu" 4
90 90 \fBkeywords\.NOT\fR: exclude files from the SCCS keywords check
91 91
92 92 .IP "\(bu" 4
93 93 \fBmapfilechk\.NOT\fR: exclude files from the linker mapfile check
94 94
95 95 .IP "" 0
96 96
↓ open down ↓ |
69 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX