README.tools (cdf0c1d55d9b3b6beaf994835440dfb01aef5cf0) README.tools (75ce41a57ff334bd8fe2cb9ed51eea835892f944)
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 2008 Sun Microsystems, Inc. All rights reserved.
22# Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23# Use is subject to license terms.
23# Use is subject to license terms.
24#
25#ident "%Z%%M% %I% %E% SMI"
26
24
25
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
31package in $(PKGARCHIVE). Installing that package will populate the
32/opt/onbld directory, and create a root account for building called 'gk',
33which uses csh and has a home directory of /opt/onbld/gk. You can
34use this account to do full builds with 'nightly'. You don't have to,
35but the 'gk' account has the path setup properly, has a .make.machines
36file for dmake, and has a .login that sets up for dmake.
37
38Layout of /opt/onbld
39--------------------
40
41/opt/onbld/etc/abi
42 contains Solaris ABI database (ABI_*.db) and exceptions
26This directory contains the tools used to do a full build of the
27OS/Net workspace. They usually live in the /opt/onbld directory on build
28machines. From here, 'make install' will build and install the tools
29in $ROOT/opt/onbld. If you like, 'make pkg' will build the SUNWonbld
30package in $(PKGARCHIVE). Installing that package will populate the
31/opt/onbld directory, and create a root account for building called 'gk',
32which uses csh and has a home directory of /opt/onbld/gk. You can
33use this account to do full builds with 'nightly'. You don't have to,
34but the 'gk' account has the path setup properly, has a .make.machines
35file for dmake, and has a .login that sets up for dmake.
36
37Layout of /opt/onbld
38--------------------
39
40/opt/onbld/etc/abi
41 contains Solaris ABI database (ABI_*.db) and exceptions
43 for ABI Auditing tool (intf_check).
42 for ABI Auditing tool (interface_check, interface_cmp).
44
45/opt/onbld/gk
46 gk account's home directory.
47
48/opt/onbld/bin
49 basic bin directory - contains scripts.
50
51/opt/onbld/bin/${MACH}

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

172 system.
173
174elfsigncmp
175 This script can be used in lieu of elfsign during a build.
176 It uses elfsign to sign a copy of the object and elfcmp -S to
177 verify that the signing caused no damage before updating
178 the object to be signed.
179
43
44/opt/onbld/gk
45 gk account's home directory.
46
47/opt/onbld/bin
48 basic bin directory - contains scripts.
49
50/opt/onbld/bin/${MACH}

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

171 system.
172
173elfsigncmp
174 This script can be used in lieu of elfsign during a build.
175 It uses elfsign to sign a copy of the object and elfcmp -S to
176 verify that the signing caused no damage before updating
177 the object to be signed.
178
179find_elf
180 Search a directory tree for ELF objects, and produce one line of
181 output per object. Used by check_rtime and interface_check to locate
182 the objects to examine.
183
180findunref
181 Finds all files in a source tree that have access times older than a
182 certain time and are not in a specified list of exceptions. Since
183 'nightly' timestamps the start of the build, and findunref uses its
184 timestamp (by default), this can be used to find all files that were
185 unreferenced during a nightly build). Since some files are only used
186 during a SPARC or Intel build, 'findunref' needs to be run on
187 workspaces from both architectures and the results need to be merged.

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

207 workspaces.
208
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
184findunref
185 Finds all files in a source tree that have access times older than a
186 certain time and are not in a specified list of exceptions. Since
187 'nightly' timestamps the start of the build, and findunref uses its
188 timestamp (by default), this can be used to find all files that were
189 unreferenced during a nightly build). Since some files are only used
190 during a SPARC or Intel build, 'findunref' needs to be run on
191 workspaces from both architectures and the results need to be merged.

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

211 workspaces.
212
213install.bin
214 binary version of /usr/sbin/install. Used to be vastly faster
215 (since /usr/sbin/install is a shell script), but may only be a bit
216 faster now. One speedup includes avoiding the name service for the
217 well-known, never-changing password entries like 'root' and 'sys.'
218
215intf_check
216 detects and reports ABI versioning and stability problems.
219interface_check
220 detects and reports invalid versioning in ELF objects.
221 Optionally generates an interface description file for
222 the workspace.
217
223
224interface_cmp
225 Compares two interface description files, as produced by
226 interface_check, and flags invalid deviations in ELF object
227 versioning between them. interface_cmp can be used between Solaris
228 gates to ensure that older releases remain compatible with the
229 development gate. It can also be used to validate new changes to
230 the development gate before they are integrated.
231
218lintdump
219 dumps the contents of one or more lint libraries; see lintdump(1)
220
221keywords
222 checks files for proper SCCS keywords.
223
224makebfu
225 simple wrapper around 'mkbfu' for use outside nightly (when in a build

--- 125 unchanged lines hidden ---
232lintdump
233 dumps the contents of one or more lint libraries; see lintdump(1)
234
235keywords
236 checks files for proper SCCS keywords.
237
238makebfu
239 simple wrapper around 'mkbfu' for use outside nightly (when in a build

--- 125 unchanged lines hidden ---