Skip to content

Commit 260e2f8

Browse files
rzezeskirmustacc
authored andcommitted
illumos#18 Fix illumos#8 link to ONBLD tools broken
1 parent 07250fe commit 260e2f8

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

anatomy

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Makefile cal.c
6161
$
6262
```
6363

64-
If you go ahead and build cal via `dmake` and bldenv(1) you'll see the
64+
If you go ahead and build cal via `dmake` and bldenv(1ONBLD) you'll see the
6565
program has been built and lands in the top level `cal` directory:
6666

6767
```

debugging

+2-2
Original file line numberDiff line numberDiff line change
@@ -738,8 +738,8 @@ build. Every compilation and program execution ends up in `nightly.log` and a
738738
large portion of the `mail_msg` is constructed from `nightly.log`.
739739

740740
The `mail_msg`, on the other hand, is a high level summary of the build itself.
741-
The file is called the `mail_msg` as you can have `nightly(1)` send you a build
742-
summary via e-mail when it finishes. It contains the time each part of the
741+
The file is called the `mail_msg` as you can have `nightly(1ONBLD)` send you a
742+
build summary via e-mail when it finishes. It contains the time each part of the
743743
build took, as well as sections on compiler warnings and errors, lint warnings
744744
and errors, and warnings and errors from the build's consistency checks. It will
745745
also show the differences from one build to the next so that way you can see

workflow

+17-17
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ your illumos distribution on the best way to take care of getting this set up.
7070

7171
### Setting up illumos.sh
7272

73-
The easiest way to do the full build is to run nightly(1). This takes care
73+
The easiest way to do the full build is to run nightly(1ONBLD). This takes care
7474
of building everything that you might care about and in the right order.
7575
`nightly` works off of a file that contains environment variables that describe
7676
how and what to build. A set up and highly commented copy of this file already
@@ -89,10 +89,10 @@ we'll ensure that we're set up to use the correct compiler.
8989

9090
As you're looking at the environment file, you'll find that the first thing you
9191
encounter is the `NIGHTLY_OPTIONS` variable. This controls what's get built by
92-
`nightly`. Sticking with the default settings will build all of the different
92+
`nightly`. Sticking with the default settings will build all of the different
9393
components for illumos in a debug-only build. If you need something else, for
9494
example a non-debug build for building a release or performance testing, please
95-
see the nightly(1) manual page.
95+
see the nightly(1ONBLD) manual page.
9696

9797
#### Setting the path to our workspace
9898

@@ -193,7 +193,7 @@ Note that if your build failed you will not generally see the file
193193

194194
## Your Best Friend while Building: bldenv
195195

196-
bldenv(1) is a tool designed to get you into a development environment for
196+
bldenv(1ONBLD) is a tool designed to get you into a development environment for
197197
doing incremental build work. Once you've done your first `nightly` it's the
198198
only way to work. To get started, you use the same `nightly` environment file
199199
that we previously set up. Let's go ahead and use `bldenv`:
@@ -436,7 +436,7 @@ preferred.
436436
One of the easiest ways to test your changes is to boot a test system onto your
437437
new bits. No matter what kind of change you've made, this should work. There are
438438
various ways to do this based on your distribution; however, for most folks this
439-
can be achieved via the build tool onu(1). If you're inside of bldenv and
439+
can be achieved via the build tool onu(1ONBLD). If you're inside of bldenv and
440440
have finished your build, the simplest way to do this is:
441441

442442
```
@@ -487,12 +487,12 @@ the binary should be almost identical to the binary from the previous build.
487487
Another use is to verify that your change did not unintentionally affect
488488
another part of the codebase.
489489

490-
illumos provides a tool that can verify this automatically:
491-
[`wsdiff(1)`](http://illumos.org/man/1onbld/wsdiff). To run `wsdiff`, specify
492-
`-w` in your `NIGHTLY_OPTIONS`. For `wsdiff` to work, it needs to be run between
493-
two consecutive builds. Therefore, the common workflow is to first build the
494-
gate with `nightly`, make your changes, and then run `nightly` again, but this
495-
time with `wsdiff` enabled.
490+
illumos provides a tool that can verify this automatically:
491+
[`wsdiff(1ONBLD)`](http://illumos.org/man/1onbld/wsdiff). To run `wsdiff`,
492+
specify `-w` in your `NIGHTLY_OPTIONS`. For `wsdiff` to work, it needs to be run
493+
between two consecutive builds. Therefore, the common workflow is to first build
494+
the gate with `nightly`, make your changes, and then run `nightly` again, but
495+
this time with `wsdiff` enabled.
496496

497497
`wsdiff` isn't perfect. There are a few things can cause noise to show up in its
498498
output. For example, the illumos `DEBUG` builds often carry macros like
@@ -562,7 +562,7 @@ need to go back and make the appropriate fixes.
562562
### webrev
563563

564564
There are lots of ways that you can share your changes with other people. The
565-
preferred format by the illumos community is that of the webrev(1). A
565+
preferred format by the illumos community is that of the webrev(1ONBLD). A
566566
`webrev` is a series of html pages that show the differences and changes in your
567567
code. `webrev` allows people to select various kinds of `diff` formats to use to
568568
look and review your changes. Unlike looking simply at a `diff` or `patch` file,
@@ -573,7 +573,7 @@ Creating a webrev is easy. All you need to do is make sure that you have your
573573
changes committed locally. It doesn't matter how many commits you have. By
574574
default, all of your uncommitted changes are compared to the head of the tree.
575575
The `webrev` tool has many options for comparing your changes against different
576-
revisions. See the `OPTIONS` section of webrev(1) if you need something
576+
revisions. See the `OPTIONS` section of webrev(1ONBLD) if you need something
577577
other than the default. Otherwise, you can generate a webrev simply by doing the
578578
following while in `bldenv`.
579579

@@ -660,10 +660,10 @@ last stop.
660660
The last step is to run `git pbchk`. `git pbchk` runs several tests on the
661661
source base including checking the commit message, style, copyright checks and a
662662
few others. To see the full list see
663-
[`git-pbchk(1)`](http://illumos.org/man/1/git-pbchk). With one exception,
664-
copyright, you should fix all of the issues listed. Whether or not you choose to
665-
put a copyright message for your modified code is up to you (and whomever
666-
actually owns the copyright).
663+
[`git-pbchk(1ONBLD)`](http://illumos.org/man/1onbld/git-pbchk). With one
664+
exception, copyright, you should fix all of the issues listed. Whether or not
665+
you choose to put a copyright message for your modified code is up to you (and
666+
whomever actually owns the copyright).
667667

668668
## Victory
669669

0 commit comments

Comments
 (0)