README.tools (d0e518695adc90b82233b99af7dffbb3d3f92c00) README.tools (cdf0c1d55d9b3b6beaf994835440dfb01aef5cf0)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

--- 5 unchanged lines hidden (view full) ---

14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21#
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

--- 5 unchanged lines hidden (view full) ---

14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21#
22# Copyright 2007 Sun Microsystems, Inc. All rights reserved.
22# Copyright 2008 Sun Microsystems, Inc. All rights reserved.
23# Use is subject to license terms.
24#
25#ident "%Z%%M% %I% %E% SMI"
26
27This directory contains the tools used to do a full build of the
28OS/Net workspace. They usually live in the /opt/onbld directory on build
29machines. From here, 'make install' will build and install the tools
30in $ROOT/opt/onbld. If you like, 'make pkg' will build the SUNWonbld

--- 18 unchanged lines hidden (view full) ---

49 basic bin directory - contains scripts.
50
51/opt/onbld/bin/${MACH}
52 architecture-specific bin directory for binaries.
53
54/opt/onbld/env
55 build environment files.
56
23# Use is subject to license terms.
24#
25#ident "%Z%%M% %I% %E% SMI"
26
27This directory contains the tools used to do a full build of the
28OS/Net workspace. They usually live in the /opt/onbld directory on build
29machines. From here, 'make install' will build and install the tools
30in $ROOT/opt/onbld. If you like, 'make pkg' will build the SUNWonbld

--- 18 unchanged lines hidden (view full) ---

49 basic bin directory - contains scripts.
50
51/opt/onbld/bin/${MACH}
52 architecture-specific bin directory for binaries.
53
54/opt/onbld/env
55 build environment files.
56
57/opt/onbld/lib
58 libraries used by the build tools.
59
60/opt/onbld/lib/python
61 python modules used by the build tools.
62
63/opt/onbld/lib/python/onbld/hgext
64 Mercurial extensions.
65
57/opt/onbld/man
58 rudimentary man pages for some of the tools.
59
60
61Tool Summary
62------------
63
64bfu

--- 17 unchanged lines hidden (view full) ---

82 built by 'nightly'. 'ws' should not be used for this since it
83 sets the environment up differently and may cause everything
84 to rebuild (because of different -I or -L paths).
85
86build_cscope
87 builds cscope databases in the uts, the platform subdirectories
88 of uts, and in usr/src. Uses cscope-fast.
89
66/opt/onbld/man
67 rudimentary man pages for some of the tools.
68
69
70Tool Summary
71------------
72
73bfu

--- 17 unchanged lines hidden (view full) ---

91 built by 'nightly'. 'ws' should not be used for this since it
92 sets the environment up differently and may cause everything
93 to rebuild (because of different -I or -L paths).
94
95build_cscope
96 builds cscope databases in the uts, the platform subdirectories
97 of uts, and in usr/src. Uses cscope-fast.
98
99cdm
100 A Mercurial extension providing various commands useful for ON
101 development
102
90check_rtime
91 checks ELF attributes used by ELF dynamic objects in the proto area.
92 Used by 'nightly's -r option, to check a number of ELF runtime
93 attributes for consistency with common build rules. nightly uses
94 the -o option to simplify the output for diffing with previous
95 build results. It also uses the -i option to obtain NEEDED and RUNPATH
96 entries, which help detect changes in software dependencies and makes
97 sure objects don't have any strange runpaths like /opt/SUNWspro/lib.

--- 12 unchanged lines hidden (view full) ---

110 Sun release keys stored on a remote signing server. This
111 directory contains signit, a client program for signing
112 files with the signing server; signproto, a shell script
113 that finds crypto modules in $ROOT and signs them using
114 signit; and codesign_server.pl, the code that runs on the
115 server. The codesign_server code is not used on an ON
116 build machine but is kept here for source control purposes.
117
103check_rtime
104 checks ELF attributes used by ELF dynamic objects in the proto area.
105 Used by 'nightly's -r option, to check a number of ELF runtime
106 attributes for consistency with common build rules. nightly uses
107 the -o option to simplify the output for diffing with previous
108 build results. It also uses the -i option to obtain NEEDED and RUNPATH
109 entries, which help detect changes in software dependencies and makes
110 sure objects don't have any strange runpaths like /opt/SUNWspro/lib.

--- 12 unchanged lines hidden (view full) ---

123 Sun release keys stored on a remote signing server. This
124 directory contains signit, a client program for signing
125 files with the signing server; signproto, a shell script
126 that finds crypto modules in $ROOT and signs them using
127 signit; and codesign_server.pl, the code that runs on the
128 server. The codesign_server code is not used on an ON
129 build machine but is kept here for source control purposes.
130
131copyrightchk
132 Checks that files have appropriate SMI copyright notices.
133 Primarily used by wx
134
118cscope-fast
119 The fast version of cscope that we use internally. Seems to work,
120 but may need more testing before it's placed in the gate. The source
121 just really needs to be here.
122
123cstyle
124 checks C source for compliance with OS/Net guidelines.
125

--- 51 unchanged lines hidden (view full) ---

177 $ findunref $SPARCSRC $SPARCSRC/tools/findunref/exception_list | \
178 sort > ~/unref-sparc.out
179 $ comm -12 ~/unref-i386.out ~/unref-sparc.out > ~/unref.out
180
181hdrchk
182 checks headers for compliance with OS/Net standards (form, includes,
183 C++ guards).
184
135cscope-fast
136 The fast version of cscope that we use internally. Seems to work,
137 but may need more testing before it's placed in the gate. The source
138 just really needs to be here.
139
140cstyle
141 checks C source for compliance with OS/Net guidelines.
142

--- 51 unchanged lines hidden (view full) ---

194 $ findunref $SPARCSRC $SPARCSRC/tools/findunref/exception_list | \
195 sort > ~/unref-sparc.out
196 $ comm -12 ~/unref-i386.out ~/unref-sparc.out > ~/unref.out
197
198hdrchk
199 checks headers for compliance with OS/Net standards (form, includes,
200 C++ guards).
201
202hgsetup
203 creates a basic Mercurial configuration for the user.
204
205hg-active
206 helper used by webrev to generate file lists for Mercurial
207 workspaces.
208
185install.bin
186 binary version of /usr/sbin/install. Used to be vastly faster
187 (since /usr/sbin/install is a shell script), but may only be a bit
188 faster now. One speedup includes avoiding the name service for the
189 well-known, never-changing password entries like 'root' and 'sys.'
190
191intf_check
192 detects and reports ABI versioning and stability problems.

--- 35 unchanged lines hidden (view full) ---

228 differences between a childs proto area and a parents.
229
230protocmp.terse
231 transforms the output of protocmp into something a bit more friendly
232
233protolist
234 create a list of what's in the proto area, to feed to protocmp.
235
209install.bin
210 binary version of /usr/sbin/install. Used to be vastly faster
211 (since /usr/sbin/install is a shell script), but may only be a bit
212 faster now. One speedup includes avoiding the name service for the
213 well-known, never-changing password entries like 'root' and 'sys.'
214
215intf_check
216 detects and reports ABI versioning and stability problems.

--- 35 unchanged lines hidden (view full) ---

252 differences between a childs proto area and a parents.
253
254protocmp.terse
255 transforms the output of protocmp into something a bit more friendly
256
257protolist
258 create a list of what's in the proto area, to feed to protocmp.
259
260rtichk
261 checks that a set of CRs have approved RTIs. Primarily used
262 by wx
263
236sccscp
237 copy a file under SCCS control to another location in a workspace.
238 also updates teamware's nametable.
239
240sccshist
241 Display the history, comments and diffs, of a file under SCCS
242 control.
243

--- 12 unchanged lines hidden (view full) ---

256 workspace. Used mostly for non-full-build workspaces, so it sets up
257 to pull headers and libraries from the proto area of the parent if
258 they aren't in the childs proto area.
259
260wx
261 A great workspace tool by bonwick. See wx.README for information
262 and warnings.
263
264sccscp
265 copy a file under SCCS control to another location in a workspace.
266 also updates teamware's nametable.
267
268sccshist
269 Display the history, comments and diffs, of a file under SCCS
270 control.
271

--- 12 unchanged lines hidden (view full) ---

284 workspace. Used mostly for non-full-build workspaces, so it sets up
285 to pull headers and libraries from the proto area of the parent if
286 they aren't in the childs proto area.
287
288wx
289 A great workspace tool by bonwick. See wx.README for information
290 and warnings.
291
292wx2hg
293 Converts a TeamWare workspace under the control of wx to a
294 Mercurial workspace, discarding intermediate deltas.
295
264tokenize
265 Used to build the sun4u boot block.
266
267webrev
268 Generates a set of HTML pages that show side-by-side diffs of
269 changes in your workspace, for easy communication of code
270 review materials. Can automagically find edited files or use a
271 manually-generated list; knows how to use wx's active file for
272 lists of checked-out files and proposed SCCS comments.
273
296tokenize
297 Used to build the sun4u boot block.
298
299webrev
300 Generates a set of HTML pages that show side-by-side diffs of
301 changes in your workspace, for easy communication of code
302 review materials. Can automagically find edited files or use a
303 manually-generated list; knows how to use wx's active file for
304 lists of checked-out files and proposed SCCS comments.
305
306which_scm
307 Reports the current Source Code Management (SCM) system in use
308 and the top-level directory of the workspace.
309
274wsdiff
275 Detect object differences between two ON proto areas. Used by
276 nightly(1) to determine what changed between two builds. Handy
277 for identifying the set of built objects impacted by a given
278 source change. This information is needed for patch construction.
279
280
281How to do a full build

--- 33 unchanged lines hidden ---
310wsdiff
311 Detect object differences between two ON proto areas. Used by
312 nightly(1) to determine what changed between two builds. Handy
313 for identifying the set of built objects impacted by a given
314 source change. This information is needed for patch construction.
315
316
317How to do a full build

--- 33 unchanged lines hidden ---