Print this page
4108 remove ON_CRYPTO_BINS from tools
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/tools/README.tools
+++ new/usr/src/tools/README.tools
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
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 #
22 22 # Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
23 23
24 24
25 25 This directory contains the tools used to do a full build of the
26 26 OS/Net workspace. They usually live in the /opt/onbld directory on build
27 27 machines. From here, 'make install' will build and install the tools
28 28 in $ROOT/opt/onbld. If you like, 'make pkg' will build the SUNWonbld
29 29 package in $(PKGARCHIVE). Installing that package will populate the
30 30 /opt/onbld directory, and create a root account for building called 'gk',
31 31 which uses csh and has a home directory of /opt/onbld/gk. You can
32 32 use this account to do full builds with 'nightly'. You don't have to,
33 33 but the 'gk' account has the path setup properly, has a .make.machines
34 34 file for dmake, and has a .login that sets up for dmake.
35 35
36 36 Layout of /opt/onbld
37 37 --------------------
38 38
39 39 /opt/onbld/etc/abi
40 40 contains Solaris ABI database (ABI_*.db) and exceptions
41 41 for ABI Auditing tool (interface_check, interface_cmp).
42 42
43 43 /opt/onbld/gk
44 44 gk account's home directory.
45 45
46 46 /opt/onbld/bin
47 47 basic bin directory - contains scripts.
48 48
49 49 /opt/onbld/bin/${MACH}
50 50 architecture-specific bin directory for binaries.
51 51
52 52 /opt/onbld/env
53 53 build environment files.
54 54
55 55 /opt/onbld/lib
56 56 libraries used by the build tools.
57 57
58 58 /opt/onbld/lib/python<version>/
59 59 python modules used by the build tools.
60 60
61 61 /opt/onbld/lib/python<version>/onbld/hgext
62 62 Mercurial extensions.
63 63
64 64 /opt/onbld/lib/python/
65 65 symlink to the modules directory of the currently preferred
66 66 python version. This exists to retain compatibility both for
67 67 tools expecting only one supported version of python, and for
68 68 user .hgrc files that expect to find cdm.py in
69 69 /opt/onbld/lib/python/onbld/hgext.
70 70
71 71 /opt/onbld/man
72 72 rudimentary man pages for some of the tools.
73 73
74 74
75 75 Tool Summary
76 76 ------------
77 77
78 78 bldenv
79 79 companion to 'nightly.' Takes the same environment file you
80 80 used with 'nightly,' and starts a shell with the environment
81 81 set up the same way as 'nightly' set it up. This is useful
82 82 if you're trying to quickly rebuild portions of a workspace
83 83 built by 'nightly'. 'ws' should not be used for this since it
84 84 sets the environment up differently and may cause everything
85 85 to rebuild (because of different -I or -L paths).
86 86
87 87 build_cscope
88 88 builds cscope databases in the uts, the platform subdirectories
89 89 of uts, and in usr/src. Uses cscope-fast.
90 90
91 91 cdm
92 92 A Mercurial extension providing various commands useful for ON
93 93 development
94 94
95 95 check_rtime
96 96 checks ELF attributes used by ELF dynamic objects in the proto area.
97 97 Used by 'nightly's -r option, to check a number of ELF runtime
98 98 attributes for consistency with common build rules. nightly uses
99 99 the -o option to simplify the output for diffing with previous
100 100 build results. It also uses the -i option to obtain NEEDED and RUNPATH
101 101 entries, which help detect changes in software dependencies and makes
102 102 sure objects don't have any strange runpaths like /opt/SUNWspro/lib.
|
↓ open down ↓ |
102 lines elided |
↑ open up ↑ |
103 103
104 104 checkproto
105 105 Runs protocmp and protolist on a workspace (or uses the environment
106 106 variable CODEMGR_WS to determine the workspace). Checks the proto area
107 107 against the packages.
108 108
109 109 codereview
110 110 Given two filenames, creates a postscript file with the file
111 111 differences highlighted.
112 112
113 -codesign
114 - Tools for signing cryptographic modules using the official
115 - Sun release keys stored on a remote signing server. This
116 - directory contains signit, a client program for signing
117 - files with the signing server; signproto, a shell script
118 - that finds crypto modules in $ROOT and signs them using
119 - signit; and codesign_server.pl, the code that runs on the
120 - server. The codesign_server code is not used on an ON
121 - build machine but is kept here for source control purposes.
122 -
123 113 copyrightchk
124 114 Checks that files have appropriate SMI copyright notices.
125 115 Primarily used by wx
126 116
127 117 cscope-fast
128 118 The fast version of cscope that we use internally. Seems to work,
129 119 but may need more testing before it's placed in the gate. The source
130 120 just really needs to be here.
131 121
132 122 cstyle
133 123 checks C source for compliance with OS/Net guidelines.
134 124
135 125 ctfconvert
136 126 Convert symbolic debugging information in an object file to the Compact
137 127 ANSI-C Type Format (CTF).
138 128
139 129 ctfdump
140 130 Decode and display CTF data stored in a raw file or in an ELF file.
141 131
142 132 ctfmerge
143 133 Merge the CTF data from one or more object files.
144 134
145 135 depcheck
146 136 A tool to try an assess the dependencies of executables. This tool
147 137 is not a definitive dependency check, but it does use "strings" and
148 138 "ldd" to gather as much information as it can. The dependency check
149 139 tool can handle filenames and pkgnames. Before using the dependency
150 140 checker you must build a database which reflects the properties and
151 141 files in your system.
152 142
153 143 elfcmp
154 144 Compares two ELF modules (e.g. .o files, executables) section by
155 145 section. Useful for determining whether "trivial" changes -
156 146 cstyle, lint, etc - actually changed the code. The -S option
157 147 is used to test whether two binaries are the same except for
158 148 the elfsign signature.
159 149
160 150 elfsign
161 151 Built from the same sources as the shipped elfsign(1), this
162 152 version is used in nightly -t builds to assure that the signing
163 153 process and format is the same as will be used on the target
164 154 system.
165 155
166 156 elfsigncmp
167 157 This script can be used in lieu of elfsign during a build.
168 158 It uses elfsign to sign a copy of the object and elfcmp -S to
169 159 verify that the signing caused no damage before updating
170 160 the object to be signed.
171 161
172 162 find_elf
173 163 Search a directory tree for ELF objects, and produce one line of
174 164 output per object. Used by check_rtime and interface_check to locate
175 165 the objects to examine.
176 166
177 167 findunref
178 168 Finds all files in a source tree that have access times older than a
179 169 certain time and are not in a specified list of exceptions. Since
180 170 'nightly' timestamps the start of the build, and findunref uses its
181 171 timestamp (by default), this can be used to find all files that were
182 172 unreferenced during a nightly build). Since some files are only used
183 173 during a SPARC or Intel build, 'findunref' needs to be run on
184 174 workspaces from both architectures and the results need to be merged.
185 175 For instance, if $INTELSRC and $SPARCSRC are set to the usr/src
186 176 directories of your Intel and SPARC nightly workspaces, then you
187 177 can merge the results like so:
188 178
189 179 $ findunref $INTELSRC $INTELSRC/tools/findunref/exception_list | \
190 180 sort > ~/unref-i386.out
191 181 $ findunref $SPARCSRC $SPARCSRC/tools/findunref/exception_list | \
192 182 sort > ~/unref-sparc.out
193 183 $ comm -12 ~/unref-i386.out ~/unref-sparc.out > ~/unref.out
194 184
195 185 hdrchk
196 186 checks headers for compliance with OS/Net standards (form, includes,
197 187 C++ guards).
198 188
199 189 hgsetup
200 190 creates a basic Mercurial configuration for the user.
201 191
202 192 hg-active
203 193 helper used by webrev to generate file lists for Mercurial
204 194 workspaces.
205 195
206 196 install.bin
207 197 binary version of /usr/sbin/install. Used to be vastly faster
208 198 (since /usr/sbin/install is a shell script), but may only be a bit
209 199 faster now. One speedup includes avoiding the name service for the
210 200 well-known, never-changing password entries like 'root' and 'sys.'
211 201
212 202 interface_check
213 203 detects and reports invalid versioning in ELF objects.
214 204 Optionally generates an interface description file for
215 205 the workspace.
216 206
217 207 interface_cmp
218 208 Compares two interface description files, as produced by
219 209 interface_check, and flags invalid deviations in ELF object
220 210 versioning between them. interface_cmp can be used between Solaris
221 211 gates to ensure that older releases remain compatible with the
222 212 development gate. It can also be used to validate new changes to
223 213 the development gate before they are integrated.
224 214
225 215 lintdump
226 216 dumps the contents of one or more lint libraries; see lintdump(1)
227 217
228 218 ndrgen
229 219 Network Data Language (NDL) RPC protocol compiler to support DCE
230 220 RPC/MSRPC and SMB/CIFS. ndrgen takes an input protocol definition
231 221 file (say, proto.ndl) and generates an output C source file
232 222 (proto_ndr.c) containing the Network Data Representation (NDR)
233 223 marshalling routines to implement the RPC protocol.
234 224
235 225 nightly
236 226 nightly build script. Takes an environment (or 'env') file describing
237 227 such things as the workspace, the parent, and what to build. See
238 228 env/developer and env/gatekeeper for sample, hopefully well-commented
239 229 env files.
240 230
241 231 pmodes
242 232 enforces proper file ownership and permissions in pkgmap and package
243 233 prototype* files. converts files if necessary
244 234
245 235 protocmp
246 236 compares proto lists and the package definitions. Used by nightly
247 237 to determine if the proto area matches the packages, and to detect
248 238 differences between a childs proto area and a parents.
249 239
250 240 protocmp.terse
251 241 transforms the output of protocmp into something a bit more friendly
252 242
253 243 protolist
254 244 create a list of what's in the proto area, to feed to protocmp.
255 245
256 246
257 247 ws
258 248 creates a shell with the environment set up to build in the given
259 249 workspace. Used mostly for non-full-build workspaces, so it sets up
260 250 to pull headers and libraries from the proto area of the parent if
261 251 they aren't in the childs proto area.
262 252
263 253 tokenize
264 254 Used to build the sun4u boot block.
265 255
266 256 webrev
267 257 Generates a set of HTML pages that show side-by-side diffs of
268 258 changes in your workspace, for easy communication of code
269 259 review materials. Can automagically find edited files or use a
270 260 manually-generated list; knows how to use wx's active file for
271 261 lists of checked-out files and proposed SCCS comments.
272 262
273 263 which_scm
274 264 Reports the current Source Code Management (SCM) system in use
275 265 and the top-level directory of the workspace.
276 266
277 267 wsdiff
278 268 Detect object differences between two ON proto areas. Used by
279 269 nightly(1) to determine what changed between two builds. Handy
280 270 for identifying the set of built objects impacted by a given
281 271 source change. This information is needed for patch construction.
282 272
283 273
284 274 How to do a full build
285 275 ----------------------
286 276
287 277 1. Find an environment file that might do what you want to do. If you're just
288 278 a developer wanting to do a full build in a child of the gate, copy the
289 279 'developer' environment file to a new name (private to you and/or the
290 280 work being done in this workspace, to avoid collisions with others). Then
291 281 edit the file and tailor it to your workspace. Remember that this file
292 282 is a shell script, so it can do more than set environment variables.
293 283
294 284 2. Login as 'gk' (or root, but your PATH and .make.machines for dmake will
295 285 not be right). Run 'nightly' and give it your environment file as an
296 286 option. 'nightly' will first look for your environment file in
297 287 /opt/onbld/env, and if it's not there then it will look for it as an
298 288 absolute or relative path. Some people put their environment files in
299 289 their workspace to keep them close.
300 290
301 291 3. When 'nightly' is complete, it will send a summary of what happened to
302 292 $MAILTO. Usually, the less info in the mail the better. If you have failures,
303 293 you can go look at the full log of what happened, generally in
304 294 $CODEMGR_WS/log/log.<date>/nightly.log (the mail_msg it sent and the proto
305 295 list are there too). You can also find the individual build logs, like
306 296 'make clobber' and 'make install' output in $SRC, under names like
307 297 clobber-${MACH}.out and install-${MACH}.out (for a DEBUG build). These
308 298 will be smaller than nightly.log, and maybe more searchable.
309 299
310 300 Files you have to update to add a tool
311 301 --------------------------------------
312 302
313 303 1. Add the tool in its appropriate place.
314 304 2. Update the Makefile as required.
315 305 3. Update usr/src/pkg/manifests/developer-build-onbld.mf
316 306 4. Update usr/src/tools/README.tools (this file).
317 307 5. Repeat 1-4 for any man pages.
|
↓ open down ↓ |
185 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX