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/which_scm.1
+++ new/usr/src/tools/scripts/which_scm.1onbld
1 1 .\"
2 2 .\" CDDL HEADER START
3 3 .\"
4 4 .\" The contents of this file are subject to the terms of the
5 5 .\" Common Development and Distribution License (the "License").
6 6 .\" You may not use this file except in compliance with the License.
7 7 .\"
8 8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 .\" or http://www.opensolaris.org/os/licensing.
10 10 .\" See the License for the specific language governing permissions
11 11 .\" and limitations under the License.
12 12 .\"
13 13 .\" When distributing Covered Code, include this CDDL HEADER in each
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
14 14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 .\" If applicable, add the following below this CDDL HEADER, with the
16 16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
18 18 .\"
19 19 .\" CDDL HEADER END
20 20 .\"
21 21 .\" Copyright 2008 Sun Microsystems, Inc. All rights reserved.
22 22 .\" Use is subject to license terms.
23 23 .\"
24 -.TH which_scm 1 "18 September 2009"
24 +.TH which_scm 1ONBLD "18 September 2009"
25 25 .SH NAME
26 26 which_scm \- Report Source Code Management system
27 27 .SH SYNOPSIS
28 28 .B which_scm
29 29
30 30 .SH DESCRIPTION
31 31 .B which_scm
32 32 detects the Source Code Management (SCM) system in use, and prints a
33 33 single line of text containing a one-word name for the SCM, followed
34 34 by a space, and then the top-level directory path for the workspace.
35 35
36 36 The typical usage within a ksh script is:
37 37 .nf
38 38 which_scm | read SCM_TYPE CODEMGR_WS || exit 1
39 39 .fi
40 40
41 41 If CODEMGR_WS is set in the environment, then \fBwhich_scm\fR
42 42 checks only that directory, assuming that it is the top of the tree.
43 43
44 44 If CODEMGR_WS is not set, then \fBwhich_scm\fR searches upwards to
45 45 find the containing workspace path, and reports that path.
46 46
47 47 .B which_scm
48 48 can detect the following types of SCM systems (these are the keywords
49 49 used in the output format):
50 50 .nf
51 51 cvs
52 52 git
53 53 mercurial
54 54 rcs
55 55 sccs
56 56 subversion
57 57 teamware
58 58 .fi
59 59
60 60 If the type of SCM in use is not known, then the string "unknown" is
61 61 printed, and the path returned is $CODEMGR_WS (if set) or the current
62 62 working directory. The command may exit with an error if the SCM
63 63 could be detected, but is unusable.
64 64
65 65 .SH ENVIRONMENT VARIABLES
66 66 The following environment variable is used by \fBwhich_scm\fR:
67 67
68 68 .PP
69 69 \fBCODEMGR_WS\fR path to current workspace.
70 70
71 71 .SH SEE ALSO
72 72 .IR cvs(1) ,
73 73 .IR git(1) ,
74 74 .IR hg(1) ,
75 75 .IR sccs(1)
76 76 .IR svn(1) ,
77 77 .IR workspace(1)
↓ open down ↓ |
43 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX