Print this page
4030 remove useless nightly/bldenv options
Reviewed by: Andy Stormont <andyjstormont@gmail.com>


 214 .TP
 215 .B \-w
 216 Report which proto area objects differ between this and the last build.
 217 See wsdiff(1) for details. Note that the proto areas used for comparison
 218 are the last ones constructed as part of the build. As an example, if both
 219 a non-debug and debug build are performed (in that order), then the debug
 220 proto area will be used for comparison (which might not be what you want).
 221 .LP
 222 .B Groups of options
 223 .TP 10
 224 .B \-G
 225 Gate keeper default group of options (-u)
 226 .TP
 227 .B \-I
 228 Integration engineer default group of options (-mpu)
 229 .TP
 230 .B \-R
 231 Default group of options for building a release (-mp)
 232 
 233 .LP
 234 .B Source Build options
 235 .TP 10
 236 .B \-S E | D | H
 237 Build the Export, Domestic, or Hybrid source product. Only Export and
 238 Domestic are truly buildable at this time.
 239 .TP 10
 240 .B \-S O
 241 Simulate an OpenSolaris build on a full tree.  This can be used by
 242 internal developers to ensure that they haven't broken the build for
 243 external developers.
 244 .LP
 245 Source build options only make sense for a full internal tree (open
 246 and closed source).  Only one source build option can be specified at
 247 a time.
 248 
 249 .LP
 250 .B Miscellaneous options
 251 .TP 10
 252 .B \-O
 253 generate deliverables for OpenSolaris.  Tarballs containing signed
 254 cryptographic binaries and binaries
 255 of closed-source components are put in $CODEMGR_WS.  (The
 256 cryptographic tarballs are copies of the
 257 ones that are put in the parent directory of
 258 $PKGARCHIVE.)
 259 .TP 10
 260 .B \-V VERS
 261 set the build version string to VERS, overriding VERSION
 262 .TP
 263 .B \-X
 264 Copies the proto area and packages from the IHV and IHV-bin gates into the
 265 nightly proto and package areas.  This is only available on i386.  See
 266 .B REALMODE ENVIRONMENT VARIABLES
 267 and
 268 .B BUILDING THE IHV WORKSPACE
 269 below.
 270 
 271 .LP
 272 .SH ENVIRONMENT VARIABLES
 273 .LP
 274 Here is a list of prominent environment variables that 
 275 .I nightly
 276 references and the meaning of each variable.
 277 .LP
 278 .RE
 279 .B CODEMGR_WS


 333 for details).
 334 .RE
 335 .LP
 336 .B SRC
 337 .RS 5
 338 Root of OS-Net source code, referenced by the Makefiles.  It is
 339 the starting point of build activity.  It should be expressed
 340 in terms of $CODEMGR_WS.
 341 .RE
 342 .LP
 343 .B ROOT
 344 .RS 5
 345 Root of the proto area for the build.  The makefiles direct
 346 installation of build products to this area and
 347 direct references to these files by builds of commands and other
 348 targets.  It should be expressed in terms of $CODEMGR_WS.
 349 .LP
 350 If $MULTI_PROTO is "no", $ROOT may contain a DEBUG or non-DEBUG
 351 build.  If $MULTI_PROTO is "yes", $ROOT contains the DEBUG build and
 352 $ROOT-nd contains the non-DEBUG build.
 353 .LP
 354 For OpenSolaris deliveries (\fB\-O\fR), $ROOT-closed contains a parallel
 355 proto area containing the DEBUG build of just usr/closed components, and
 356 $ROOT-nd-closed contains the non-DEBUG equivalent.
 357 .RE
 358 .LP
 359 .B TOOLS_ROOT
 360 .RS 5
 361 Root of the tools proto area for the build.  The makefiles direct
 362 installation of tools build products to this area.  Unless \fB+t\fR
 363 is part of $NIGHTLY_OPTIONS, these tools will be used during the
 364 build.
 365 .LP
 366 As built by nightly, this will always contain non-DEBUG objects.
 367 Therefore, this will always have a -nd suffix, regardless of
 368 $MULTI_PROTO.
 369 .RE
 370 .LP
 371 .B MACH
 372 .RS 5
 373 The instruction set architecture of the build machine as given
 374 by \fIuname -p\fP, e.g. sparc, i386.
 375 .RE
 376 .LP


 515 .RS 5
 516 The location for the java compilers for the build, generally /usr/java.
 517 .RE
 518 .LP
 519 .B OPTHOME
 520 .RS 5
 521 The gate-defined default location of things formerly in /opt; e.g.,
 522 /ws/onnv-tools.  This is used by nightly, but not the makefiles.
 523 .RE
 524 .LP
 525 .B TEAMWARE
 526 .RS 5
 527 The gate-defined default location for the Teamware tools; e.g.,
 528 /ws/onnv-tools/SUNWspro.  By default, it is derived from
 529 .BR OPTHOME .
 530 This is used by nightly, but not the makefiles.  There is no
 531 corresponding variable for Mercurial or Subversion, which are assumed
 532 to be installed in the default path.
 533 .RE
 534 .LP
 535 .B OPEN_SRCDIR
 536 .RS 5
 537 The open source tree is copied to this directory when simulating an
 538 OpenSolaris build (\fB\-S O\fR).  It defaults to $CODEMGR_WS/open_src.
 539 .LP
 540 .RE
 541 .B ON_CLOSED_BINS
 542 .RS 5
 543 OpenSolaris builds do not contain the closed source tree.  Instead,
 544 the developer downloads a closed binaries tree and unpacks it.  
 545 .B ON_CLOSED_BINS
 546 tells nightly
 547 where to find these closed binaries, so that it can add them into the
 548 build.
 549 .LP
 550 .RE
 551 .B ON_CRYPTO_BINS
 552 .RS 5
 553 This is the path to a compressed tarball that contains debug
 554 cryptographic binaries that have been signed to allow execution
 555 outside of Sun, e.g., $PARENT_WS/packages/$MACH/on-crypto.$MACH.bz2.
 556 .I nightly
 557 will automatically adjust the path for non-debug builds.  This tarball
 558 is needed if the closed-source tree is not present.  Also, it is
 559 usually needed when generating OpenSolaris deliverables from a project
 560 workspace.  This is because most projects do not have access to the


 566 .RS 5
 567 Normally, nightly runs the 'checkpaths' script to check for
 568 discrepancies among the files that list paths to other files, such as
 569 exception lists and req.flg.  Set this flag to 'n' to disable this
 570 check, which appears in the nightly output as "Check lists of files."
 571 .RE
 572 .LP
 573 .B CHECK_DMAKE
 574 .RS 5
 575 Nightly validates that the version of dmake encountered is known to be
 576 safe to use.  Set this flag to 'n' to disable this test, allowing any
 577 version of dmake to be used.
 578 .RE
 579 .LP
 580 .B MULTI_PROTO
 581 .RS 5
 582 If "no" (the default), 
 583 .I nightly
 584 will reuse $ROOT for both the DEBUG and non-DEBUG builds.  If "yes",
 585 the DEBUG build will go in $ROOT and the non-DEBUG build will go in
 586 $ROOT-nd.  Other values will be treated as "no".  Use of the
 587 .B \-O
 588 flag forces MULTI_PROTO to "yes".
 589 .RE
 590 .LP
 591 .SH NIGHTLY HOOK ENVIRONMENT VARIABLES
 592 .LP
 593 Several optional environment variables may specify commands to run at
 594 various points during the build.  Commands specified in the hook
 595 variable will be run in a subshell; command output will be appended to
 596 the mail message and log file.  If the hook exits with a non-zero
 597 status, the build is aborted immediately.  Environment variables
 598 defined in the environment file will be available.
 599 .LP
 600 .B SYS_PRE_NIGHTLY
 601 .RS 5
 602 Run just after the workspace lock is acquired.  This is reserved for
 603 per-build-machine customizations and should be set only in /etc/nightly.conf
 604 .RE
 605 .LP
 606 .B PRE_NIGHTLY
 607 .RS 5
 608 Run just after SYS_PRE_NIGHTLY.




 214 .TP
 215 .B \-w
 216 Report which proto area objects differ between this and the last build.
 217 See wsdiff(1) for details. Note that the proto areas used for comparison
 218 are the last ones constructed as part of the build. As an example, if both
 219 a non-debug and debug build are performed (in that order), then the debug
 220 proto area will be used for comparison (which might not be what you want).
 221 .LP
 222 .B Groups of options
 223 .TP 10
 224 .B \-G
 225 Gate keeper default group of options (-u)
 226 .TP
 227 .B \-I
 228 Integration engineer default group of options (-mpu)
 229 .TP
 230 .B \-R
 231 Default group of options for building a release (-mp)
 232 
 233 .LP
















 234 .B Miscellaneous options
 235 .TP 10








 236 .B \-V VERS
 237 set the build version string to VERS, overriding VERSION
 238 .TP
 239 .B \-X
 240 Copies the proto area and packages from the IHV and IHV-bin gates into the
 241 nightly proto and package areas.  This is only available on i386.  See
 242 .B REALMODE ENVIRONMENT VARIABLES
 243 and
 244 .B BUILDING THE IHV WORKSPACE
 245 below.
 246 
 247 .LP
 248 .SH ENVIRONMENT VARIABLES
 249 .LP
 250 Here is a list of prominent environment variables that 
 251 .I nightly
 252 references and the meaning of each variable.
 253 .LP
 254 .RE
 255 .B CODEMGR_WS


 309 for details).
 310 .RE
 311 .LP
 312 .B SRC
 313 .RS 5
 314 Root of OS-Net source code, referenced by the Makefiles.  It is
 315 the starting point of build activity.  It should be expressed
 316 in terms of $CODEMGR_WS.
 317 .RE
 318 .LP
 319 .B ROOT
 320 .RS 5
 321 Root of the proto area for the build.  The makefiles direct
 322 installation of build products to this area and
 323 direct references to these files by builds of commands and other
 324 targets.  It should be expressed in terms of $CODEMGR_WS.
 325 .LP
 326 If $MULTI_PROTO is "no", $ROOT may contain a DEBUG or non-DEBUG
 327 build.  If $MULTI_PROTO is "yes", $ROOT contains the DEBUG build and
 328 $ROOT-nd contains the non-DEBUG build.




 329 .RE
 330 .LP
 331 .B TOOLS_ROOT
 332 .RS 5
 333 Root of the tools proto area for the build.  The makefiles direct
 334 installation of tools build products to this area.  Unless \fB+t\fR
 335 is part of $NIGHTLY_OPTIONS, these tools will be used during the
 336 build.
 337 .LP
 338 As built by nightly, this will always contain non-DEBUG objects.
 339 Therefore, this will always have a -nd suffix, regardless of
 340 $MULTI_PROTO.
 341 .RE
 342 .LP
 343 .B MACH
 344 .RS 5
 345 The instruction set architecture of the build machine as given
 346 by \fIuname -p\fP, e.g. sparc, i386.
 347 .RE
 348 .LP


 487 .RS 5
 488 The location for the java compilers for the build, generally /usr/java.
 489 .RE
 490 .LP
 491 .B OPTHOME
 492 .RS 5
 493 The gate-defined default location of things formerly in /opt; e.g.,
 494 /ws/onnv-tools.  This is used by nightly, but not the makefiles.
 495 .RE
 496 .LP
 497 .B TEAMWARE
 498 .RS 5
 499 The gate-defined default location for the Teamware tools; e.g.,
 500 /ws/onnv-tools/SUNWspro.  By default, it is derived from
 501 .BR OPTHOME .
 502 This is used by nightly, but not the makefiles.  There is no
 503 corresponding variable for Mercurial or Subversion, which are assumed
 504 to be installed in the default path.
 505 .RE
 506 .LP






 507 .B ON_CLOSED_BINS
 508 .RS 5
 509 OpenSolaris builds do not contain the closed source tree.  Instead,
 510 the developer downloads a closed binaries tree and unpacks it.  
 511 .B ON_CLOSED_BINS
 512 tells nightly
 513 where to find these closed binaries, so that it can add them into the
 514 build.
 515 .LP
 516 .RE
 517 .B ON_CRYPTO_BINS
 518 .RS 5
 519 This is the path to a compressed tarball that contains debug
 520 cryptographic binaries that have been signed to allow execution
 521 outside of Sun, e.g., $PARENT_WS/packages/$MACH/on-crypto.$MACH.bz2.
 522 .I nightly
 523 will automatically adjust the path for non-debug builds.  This tarball
 524 is needed if the closed-source tree is not present.  Also, it is
 525 usually needed when generating OpenSolaris deliverables from a project
 526 workspace.  This is because most projects do not have access to the


 532 .RS 5
 533 Normally, nightly runs the 'checkpaths' script to check for
 534 discrepancies among the files that list paths to other files, such as
 535 exception lists and req.flg.  Set this flag to 'n' to disable this
 536 check, which appears in the nightly output as "Check lists of files."
 537 .RE
 538 .LP
 539 .B CHECK_DMAKE
 540 .RS 5
 541 Nightly validates that the version of dmake encountered is known to be
 542 safe to use.  Set this flag to 'n' to disable this test, allowing any
 543 version of dmake to be used.
 544 .RE
 545 .LP
 546 .B MULTI_PROTO
 547 .RS 5
 548 If "no" (the default), 
 549 .I nightly
 550 will reuse $ROOT for both the DEBUG and non-DEBUG builds.  If "yes",
 551 the DEBUG build will go in $ROOT and the non-DEBUG build will go in
 552 $ROOT-nd.  Other values will be treated as "no".


 553 .RE
 554 .LP
 555 .SH NIGHTLY HOOK ENVIRONMENT VARIABLES
 556 .LP
 557 Several optional environment variables may specify commands to run at
 558 various points during the build.  Commands specified in the hook
 559 variable will be run in a subshell; command output will be appended to
 560 the mail message and log file.  If the hook exits with a non-zero
 561 status, the build is aborted immediately.  Environment variables
 562 defined in the environment file will be available.
 563 .LP
 564 .B SYS_PRE_NIGHTLY
 565 .RS 5
 566 Run just after the workspace lock is acquired.  This is reserved for
 567 per-build-machine customizations and should be set only in /etc/nightly.conf
 568 .RE
 569 .LP
 570 .B PRE_NIGHTLY
 571 .RS 5
 572 Run just after SYS_PRE_NIGHTLY.