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