usr/src/tools/scripts/git-pbchk.1

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