Skip to content

Commit 0b13d1c

Browse files
committed
bogus initial attempt at describing gerrit
1 parent 9e82950 commit 0b13d1c

File tree

3 files changed

+22
-40
lines changed

3 files changed

+22
-40
lines changed

help

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ distribution specific IRC channel which are generally also found on
6868

6969
### Help Us Help You
7070

71-
In any case, please remember that people can only help you if you provide
72-
them enough information. If you have a program dumping core or the operating
73-
system is panicking, then please find some way to make that available. If you
74-
have questions about code that you have written consider making a webrev of your
75-
changes available.
71+
In any case, please remember that people can only help you if you provide them
72+
enough information. If you have a program dumping core or the operating system
73+
is panicking, then please find some way to make that available. If you have
74+
questions about code that you have written consider making a work-in-progress
75+
version of your changes available as a git branch or gerrit code review.
7676

7777
If you are hitting a bug that you do not understand in the compiler, then please
7878
include the full compilation line. In some build systems you may be required to

integrating

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,7 @@ submitting your RTI. Furthermore, if there are issues or disagreements about
6767
things between you and your reviewers, that is something that you need to tell
6868
the advocates.
6969

70-
When providing materials for review, the best form of this is a `webrev`. For
71-
information on generating it, please read [the workflow section on
72-
webrev](./workflow.html#webrev). If you have written custom testing software,
73-
you should make that available. This will not only help reviewers better
74-
understand how your changes work, but they will also be able to provide feedback
75-
on the testing and may be able to find cracks in the test plan.
70+
Code reviews are conducted using [gerrit](https://code.illumos.org).
7671

7772
#### Finding Reviewers
7873

@@ -149,9 +144,6 @@ which checks everything that is in the proto area.
149144

150145
The advocates are going to apply your changes to the gate. As we are using
151146
`git`, the best way to do this is by attaching the output of `git format-patch`.
152-
While `webrev` generates a patch, it isn't always the most useful, as it leads
153-
to people trying to manually add missing files which can be an error prone
154-
process.
155147

156148
If isn't required for you to have merged your changes into the head of the tree,
157149
but if your advocate is doing so and runs into substantial trouble with that,

workflow

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -559,34 +559,24 @@ The easiest way to do check all of this is to simply run `nightly` again and
559559
look at the contents of the `mail_msg`. If you see errors from there, you will
560560
need to go back and make the appropriate fixes.
561561

562-
### webrev
563-
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(1ONBLD). A
566-
`webrev` is a series of html pages that show the differences and changes in your
567-
code. `webrev` allows people to select various kinds of `diff` formats to use to
568-
look and review your changes. Unlike looking simply at a `diff` or `patch` file,
569-
a `webrev` breaks down the changes on a per-file basis and allows for the reader
570-
to get much more context than normally is possible.
571-
572-
Creating a webrev is easy. All you need to do is make sure that you have your
573-
changes committed locally. It doesn't matter how many commits you have. By
574-
default, all of your uncommitted changes are compared to the head of the tree.
575-
The `webrev` tool has many options for comparing your changes against different
576-
revisions. See the `OPTIONS` section of webrev(1ONBLD) if you need something
577-
other than the default. Otherwise, you can generate a webrev simply by doing the
578-
following while in `bldenv`.
579-
580-
```
581-
$ webrev
582-
$ find /ws/rm/illumos-gate/webrev
583-
$
562+
### Gerrit
563+
564+
Code review for illumos is conducted in [Gerrit](http://code.illumos.org),
565+
it's own
566+
[documentation](https://code.illumos.org/Documentation/user-upload.html)
567+
provides complete details. Briefly, you will push your code to a specially
568+
named branch, which will create the review. Authentication is via your
569+
illumos ssh key in redmine.
570+
571+
```
572+
git push ssh://[email protected]/illumos-gate your-branch:refs/for/master
584573
```
585574

586-
You'll want to share your webrev with your reviewers. If you don't have a place
587-
to upload it or share with them, the illumos community provides some common
588-
places for that which is `cr.illumos.org`. See XXX for more information on
589-
using `cr.illumos.org`.
575+
Will create a review for `your-branch`, and output its URL.
576+
Each commit in your branch will be a separate review, though each will be
577+
grouped together, and each needs a `Change-Id` line, as described in the
578+
Gerrit documentation (the error message should you not do this will tell you
579+
how to enable a hook to create them automatically, should you want to).
590580

591581
### Reviewers
592582

0 commit comments

Comments
 (0)