Print this page 
8998 depcheck is useless and should be removed
8992 checkproto is useless and can be deleted
8991 pmodes is useless and can be deleted
8990 /opt/onbld/gk is useless
Split Close
Expand all
Collapse all
          --- old/usr/src/tools/README.tools
          +++ new/usr/src/tools/README.tools
↓ open down ↓ 17 lines elided ↑ open up ↑ 
  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      -in $ROOT/opt/onbld. If you like, 'make pkg' will build the SUNWonbld
  29      -package in $(PKGARCHIVE). Installing that package will populate the
  30      -/opt/onbld directory, and create a root account for building called 'gk',
  31      -which uses csh and has a home directory of /opt/onbld/gk. You can
  32      -use this account to do full builds with 'nightly'. You don't have to,
  33      -but the 'gk' account has the path setup properly, has a .make.machines
  34      -file for dmake, and has a .login that sets up for dmake.
       28 +in $ROOT/opt/onbld.
  35   29  
  36   30  Layout of /opt/onbld
  37   31  --------------------
  38   32  
  39   33  /opt/onbld/etc/abi
  40   34          contains Solaris ABI database (ABI_*.db) and exceptions
  41   35          for ABI Auditing tool (interface_check, interface_cmp).
  42   36  
  43      -/opt/onbld/gk
  44      -        gk account's home directory.
  45      -
  46   37  /opt/onbld/bin
  47   38          basic bin directory - contains scripts.
  48   39  
  49   40  /opt/onbld/bin/${MACH}
  50   41          architecture-specific bin directory for binaries.
  51   42  
  52   43  /opt/onbld/env
  53   44          build environment files.
  54   45  
  55   46  /opt/onbld/lib
↓ open down ↓ 38 lines elided ↑ open up ↑ 
  94   85  
  95   86  check_rtime
  96   87          checks ELF attributes used by ELF dynamic objects in the proto area.
  97   88          Used by 'nightly's -r option, to check a number of ELF runtime
  98   89          attributes for consistency with common build rules.  nightly uses
  99   90          the -o option to simplify the output for diffing with previous
 100   91          build results.  It also uses the -i option to obtain NEEDED and RUNPATH
 101   92          entries, which help detect changes in software dependencies and makes
 102   93          sure objects don't have any strange runpaths like /opt/SUNWspro/lib.
 103   94  
 104      -checkproto
 105      -        Runs protocmp and protolist on a workspace (or uses the environment
 106      -        variable CODEMGR_WS to determine the workspace). Checks the proto area
 107      -        against the packages.
 108      -
 109   95  codereview
 110   96          Given two filenames, creates a postscript file with the file 
 111   97          differences highlighted.
 112   98  
 113   99  codesign
 114  100          Tools for signing cryptographic modules using the official
 115  101          Sun release keys stored on a remote signing server. This
 116  102          directory contains signit, a client program for signing
 117  103          files with the signing server; signproto, a shell script
 118  104          that finds crypto modules in $ROOT and signs them using
↓ open down ↓ 16 lines elided ↑ open up ↑ 
 135  121  ctfconvert
 136  122          Convert symbolic debugging information in an object file to the Compact
 137  123          ANSI-C Type Format (CTF).
 138  124  
 139  125  ctfdump
 140  126          Decode and display CTF data stored in a raw file or in an ELF file.
 141  127  
 142  128  ctfmerge
 143  129          Merge the CTF data from one or more object files.
 144  130  
 145      -depcheck
 146      -        A tool to try an assess the dependencies of executables.  This tool 
 147      -        is not a definitive dependency check, but it does use "strings" and 
 148      -        "ldd" to gather as much information as it can.  The dependency check
 149      -        tool can handle filenames and pkgnames.  Before using the dependency
 150      -        checker you must build a database which reflects the properties and
 151      -        files in your system.
 152      -
 153  131  elfcmp
 154  132          Compares two ELF modules (e.g. .o files, executables) section by
 155  133          section.  Useful for determining whether "trivial" changes -
 156  134          cstyle, lint, etc - actually changed the code.  The -S option
 157  135          is used to test whether two binaries are the same except for
 158  136          the elfsign signature.
 159  137  
 160  138  find_elf
 161  139          Search a directory tree for ELF objects, and produce one line of
 162  140          output per object. Used by check_rtime and interface_check to locate
↓ open down ↓ 56 lines elided ↑ open up ↑ 
 219  197          file (say, proto.ndl) and generates an output C source file
 220  198          (proto_ndr.c) containing the Network Data Representation (NDR)
 221  199          marshalling routines to implement the RPC protocol.
 222  200  
 223  201  nightly
 224  202          nightly build script. Takes an environment (or 'env') file describing
 225  203          such things as the workspace, the parent, and what to build. See
 226  204          env/developer and env/gatekeeper for sample, hopefully well-commented
 227  205          env files.
 228  206  
 229      -pmodes
 230      -        enforces proper file ownership and permissions in pkgmap and package
 231      -        prototype* files.  converts files if necessary
 232      -
 233  207  protocmp
 234  208          compares proto lists and the package definitions. Used by nightly
 235  209          to determine if the proto area matches the packages, and to detect
 236  210          differences between a childs proto area and a parents.
 237  211  
 238  212  protocmp.terse
 239  213          transforms the output of protocmp into something a bit more friendly
 240  214  
 241  215  protolist
 242  216          create a list of what's in the proto area, to feed to protocmp.
↓ open down ↓ 29 lines elided ↑ open up ↑ 
 272  246  How to do a full build
 273  247  ----------------------
 274  248  
 275  249  1. Find an environment file that might do what you want to do. If you're just
 276  250     a developer wanting to do a full build in a child of the gate, copy the
 277  251     'developer' environment file to a new name (private to you and/or the
 278  252     work being done in this workspace, to avoid collisions with others). Then
 279  253     edit the file and tailor it to your workspace. Remember that this file
 280  254     is a shell script, so it can do more than set environment variables.
 281  255  
 282      -2. Login as 'gk' (or root, but your PATH and .make.machines for dmake will
 283      -   not be right). Run 'nightly' and give it your environment file as an
      256 +2. Run 'nightly' and give it your environment file as an
 284  257     option. 'nightly' will first look for your environment file in
 285  258     /opt/onbld/env, and if it's not there then it will look for it as an
 286  259     absolute or relative path. Some people put their environment files in
 287  260     their workspace to keep them close.
 288  261  
 289  262  3. When 'nightly' is complete, it will send a summary of what happened to
 290  263     $MAILTO. Usually, the less info in the mail the better. If you have failures,
 291  264     you can go look at the full log of what happened, generally in
 292  265     $CODEMGR_WS/log/log.<date>/nightly.log (the mail_msg it sent and the proto
 293  266     list are there too). You can also find the individual build logs, like
↓ open down ↓ 12 lines elided ↑ open up ↑ 
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX