Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/tools/scripts/wsdiff.1onbld
+++ new/usr/src/tools/scripts/wsdiff.1onbld
1 1 .\" " CDDL HEADER START
2 2 .\" "
3 3 .\" " The contents of this file are subject to the terms of the
4 4 .\" " Common Development and Distribution License (the "License").
5 5 .\" " You may not use this file except in compliance with the License.
6 6 .\" "
7 7 .\" " You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8 8 .\" " or http://www.opensolaris.org/os/licensing.
9 9 .\" " See the License for the specific language governing permissions
10 10 .\" " and limitations under the License.
11 11 .\" "
|
↓ open down ↓ |
11 lines elided |
↑ open up ↑ |
12 12 .\" " When distributing Covered Code, include this CDDL HEADER in each
13 13 .\" " file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14 14 .\" " If applicable, add the following below this CDDL HEADER, with the
15 15 .\" " fields enclosed by brackets "[]" replaced with your own identifying
16 16 .\" " information: Portions Copyright [yyyy] [name of copyright owner]
17 17 .\" "
18 18 .\" " CDDL HEADER END
19 19 .\" "
20 20 .\" " Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
21 21 .\" "
22 -.TH wsdiff 1ONBLD "15 Jul 2010"
22 +.TH WSDIFF 1ONBLD "Jul 15, 2010"
23 23 .I wsdiff
24 24 \- report differences between proto area objects
25 25 .SH SYNOPSIS
26 26 \fBwsdiff [-dvVst] [-r \fIresults\fP] [-i \fIfilelist\fP] \fIold\fP \fInew\fP
27 -.LP
28 27 .SH DESCRIPTION
29 -.IX "OS-Net build tools" "wsdiff" "" "\fBwsdiff\fP"
30 28 .LP
31 29 The wsdiff utility detects and reports on object differences found between
32 30 two proto areas constructed from the same workspace. This can be useful
33 31 when trying to understand which objects have changed as a result of a particular
34 32 source change.
35 33 .LP
36 34 \fIold\fP specifies the baseline proto area constructed without the source
37 35 change. \fInew\fP specifies the proto area constructed with the source
38 36 change. Both \fIold\fP and \fInew\fP should be constructed from the same
39 37 workspace, otherwise wsdiff will find object differences not associated
40 38 with the source change.
41 39 .SH OPTIONS
42 40 .TP 10
43 41 .B -d
44 42 Print debug information. The debug lines are prefixed with ##.
45 43 .TP 10
46 44 .B -v
47 45 Do not truncate the diffs logged to the results file. By default wsdiff
48 46 will truncate the length of a sufficiently long set of object diffs to preserve
49 47 the readability of the results file. -v can be used to override this behaviour.
50 48 .TP 10
51 49 .B -V
52 50 Log observed differences for all ELF sections, rather than logging only the first
53 51 difference found. When wsdiff encounters an ELF section difference, by default
54 52 it will log the difference associated with that section only, and move on. -V forces
55 53 wsdiff to log all ELF section differences found between two objects, rather than
56 54 just the first. Because of the extra work involved, this may slow wsdiff down
57 55 considerably.
58 56 .TP 10
59 57 .B -s
60 58 Produce sorted lists. This is handy when comparing multiple wsdiff outputs
61 59 because wsdiff runs in multithreaded mode so the list of differences is not
62 60 sorted and can differ between multiple runs.
63 61 .TP 10
|
↓ open down ↓ |
24 lines elided |
↑ open up ↑ |
64 62 .B -t
65 63 Look for the onbld tools in $SRC/tools rather than /opt/onbld/bin
66 64 .TP 10
67 65 .B -r
68 66 Log results to the specified log file. The log file contains a list of new, deleted,
69 67 and changed objects, as well as diffs signifying what wsdiff found to be different.
70 68 .TP 10
71 69 .B -i
72 70 Specify which objects should be compared by wsdiff via an input file list (See
73 71 EXAMPLES).
74 -.LP
75 72 .SH OUTPUT
76 73 .LP
77 74 The list of objects appearing to differ between \fIold\fP and \fInew\fP is
78 75 printed to stdout. If -r was specified, the list of differing objects and
79 76 their differrences are logged to \fIresults\fP.
80 -.LP
81 77 .SH EXAMPLES
82 78 .PP
83 79 \fBExample 1: Using wsdiff to determine patch deliverables\fR
84 80 .PP
85 81 The following example shows how to use wsdiff to determine the set of objects
86 82 requiring (re)delivery via patch as a result of a given source change:
87 83 .LP
88 84 Starting with a built workspace, move the existing proto area aside:
89 85 .LP
90 86 .nf
91 87 user@example$ ls
92 88 Codemgr_wsdata/ proto/ usr/
93 89
94 90 user@example$ mv proto proto.old
95 91 .fi
96 92 .LP
97 93 Next, integrate the source changes, rebuild, and invoke wsdiff specifying the
98 94 old and new proto areas:
99 95 .LP
100 96 .nf
101 97 user@example$ ls
102 98 Codemgr_wsdata/ proto/ proto.old/ usr/
103 99
104 100 user@example$ wsdiff proto.old proto
105 101 platform/SUNW,SPARC-Enterprise/kernel/sparcv9/unix
106 102 platform/SUNW,Sun-Fire-15000/kernel/sparcv9/unix
107 103 platform/sun4v/kernel/sparcv9/unix
108 104 platform/sun4u/kernel/sparcv9/unix
109 105 platform/SUNW,Ultra-Enterprise-10000/kernel/sparcv9/unix
110 106 platform/SUNW,Sun-Fire/kernel/sparcv9/unix
111 107 .fi
112 108 .PP
113 109 \fBExample 2: The wsdiff results file\fR
114 110 .PP
115 111 With the -r option, wsdiff will log the list of objects that appear different, as well
116 112 as a set of diffs highlighting the observed difference:
117 113 .LP
118 114 .nf
119 115 user@example$ wsdiff -r results proto.old proto
120 116 platform/SUNW,SPARC-Enterprise/kernel/sparcv9/unix
121 117 platform/SUNW,Sun-Fire-15000/kernel/sparcv9/unix
122 118 platform/sun4v/kernel/sparcv9/unix
123 119 platform/sun4u/kernel/sparcv9/unix
124 120 platform/SUNW,Ultra-Enterprise-10000/kernel/sparcv9/unix
125 121 platform/SUNW,Sun-Fire/kernel/sparcv9/unix
126 122
127 123 user@example$ cat results
128 124 # This file was produced by wsdiff
129 125 # 2006/7/10 at 18:28:56
130 126 Base proto area: proto.old/
131 127 Patch (new) proto area: proto/
132 128 Results file: results
133 129
134 130 platform/SUNW,SPARC-Enterprise/kernel/sparcv9/unix
135 131 NOTE: ELF .text difference detected.
136 132
137 133 89562,89567c89562,89567
138 134 < lgrp_cpu_init+0x158: 9e 10 20 01 mov 0x1, %o7
139 135 < lgrp_cpu_init+0x15c: b3 2b d0 1c sllx %o7, %i4, %i1
140 136 < lgrp_cpu_init+0x160: 9a 12 40 19 or %o1, %i1, %o5
141 137 < lgrp_cpu_init+0x164: da 76 a0 30 stx %o5, [%i2 + 0x30]
|
↓ open down ↓ |
51 lines elided |
↑ open up ↑ |
142 138 < lgrp_cpu_init+0x168: d8 04 e0 00 ld [%l3], %o4
143 139 < lgrp_cpu_init+0x16c: 80 a3 20 00 cmp %o4, 0x0
144 140 ---
145 141 > lgrp_cpu_init+0x158: 9a 10 20 01 mov 0x1, %o5
146 142 > lgrp_cpu_init+0x15c: b3 2b 50 1c sllx %o5, %i4, %i1
147 143 > lgrp_cpu_init+0x160: 98 12 00 19 or %o0, %i1, %o4
148 144 > lgrp_cpu_init+0x164: d8 76 a0 30 stx %o4, [%i2 + 0x30]
149 145 > lgrp_cpu_init+0x168: d6 04 e0 00 ld [%l3], %o3
150 146 > lgrp_cpu_init+0x16c: 80 a2 e0 00 cmp %o3, 0x0
151 147
152 -...
153 148
154 149 .fi
155 150 .PP
156 151 \fBExample 3: Using an input file list\fR
157 152 .PP
158 153 The -i option tells wsdiff to compare a specific list of objects. This can be useful
159 154 in conjunction with other options that direct wsdiff to log more verbosely, allowing
160 155 one to "drill down" into a particular object's differences:
161 156 .LP
162 157 .nf
163 158 user@example$ echo "usr/lib/mdb/kvm/sparcv9/genunix.so" > flist
164 159 user@example$ wsdiff -vV -r results -i flist proto.old proto
165 160 usr/lib/mdb/kvm/sparcv9/genunix.so
166 161
167 162 user@example$ cat results
168 163 <... verbose differences only for genunix.so ...>
169 164 .fi
170 165 .PP
171 166 \fBExample 4: Invoking wsdiff through nightly(1ONBLD)\fR
172 167 .PP
173 168 By specifying -w in NIGHTLY_OPTIONS, nightly(1ONBLD) will use wsdiff(1ONBLD) to determine
174 169 which objects look different, compared to the previous build. A pre-existing proto area
175 170 must exist for wsdiff(1ONBLD) to compare against. nightly(1ONBLD) will move aside the
176 171 pre-existing proto area (renaming it to $ROOT.prev under proto), and will
177 172 invoke wsdiff at the end of the build. The list of changed objects will be reported
178 173 in the nightly mail message, and a results file "wsdiff_results" will appear in the
179 174 nightly log area.
180 175 .PP
181 176 \fBExample 5: Influencing the level of paralelism\fR
182 177 .PP
183 178 wsdiff spawns a number of threads by default after it determines the list
|
↓ open down ↓ |
21 lines elided |
↑ open up ↑ |
184 179 of files for comparison. Default number of threads is based on the number of
185 180 on-line CPUs present in the system. To set the number of threads for processing
186 181 to some other value the DMAKE_MAX_JOBS environment variable can be used:
187 182 .LP
188 183 .nf
189 184 $ DMAKE_MAX_JOBS=24 wsdiff proto_base proto_patch
190 185 .fi
191 186 .PP
192 187 Note that this variable is also used for nightly(1ONBLD) so when run from
193 188 nightly(1ONBLD), wsdiff will honor the setting.
194 -.LP
195 189 .SH SEE ALSO
196 190 .LP
197 191 .IR nightly(1ONBLD),
198 192 .IR elfdump(1),
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX