@@ -70,7 +70,7 @@ your illumos distribution on the best way to take care of getting this set up.
70
70
71
71
### Setting up illumos.sh
72
72
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
74
74
of building everything that you might care about and in the right order.
75
75
`nightly` works off of a file that contains environment variables that describe
76
76
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.
89
89
90
90
As you're looking at the environment file, you'll find that the first thing you
91
91
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
93
93
components for illumos in a debug-only build. If you need something else, for
94
94
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.
96
96
97
97
#### Setting the path to our workspace
98
98
@@ -193,7 +193,7 @@ Note that if your build failed you will not generally see the file
193
193
194
194
## Your Best Friend while Building: bldenv
195
195
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
197
197
doing incremental build work. Once you've done your first `nightly` it's the
198
198
only way to work. To get started, you use the same `nightly` environment file
199
199
that we previously set up. Let's go ahead and use `bldenv`:
@@ -436,7 +436,7 @@ preferred.
436
436
One of the easiest ways to test your changes is to boot a test system onto your
437
437
new bits. No matter what kind of change you've made, this should work. There are
438
438
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
440
440
have finished your build, the simplest way to do this is:
441
441
442
442
```
@@ -487,12 +487,12 @@ the binary should be almost identical to the binary from the previous build.
487
487
Another use is to verify that your change did not unintentionally affect
488
488
another part of the codebase.
489
489
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.
496
496
497
497
`wsdiff` isn't perfect. There are a few things can cause noise to show up in its
498
498
output. For example, the illumos `DEBUG` builds often carry macros like
@@ -562,7 +562,7 @@ need to go back and make the appropriate fixes.
562
562
### webrev
563
563
564
564
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
566
566
`webrev` is a series of html pages that show the differences and changes in your
567
567
code. `webrev` allows people to select various kinds of `diff` formats to use to
568
568
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
573
573
changes committed locally. It doesn't matter how many commits you have. By
574
574
default, all of your uncommitted changes are compared to the head of the tree.
575
575
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
577
577
other than the default. Otherwise, you can generate a webrev simply by doing the
578
578
following while in `bldenv`.
579
579
@@ -660,10 +660,10 @@ last stop.
660
660
The last step is to run `git pbchk`. `git pbchk` runs several tests on the
661
661
source base including checking the commit message, style, copyright checks and a
662
662
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).
667
667
668
668
## Victory
669
669
0 commit comments