Page History

The following applies only to Mercurial (hg) repositories. For GIT repositories, the Skara tooling provides jcheck.

The various JDK projects on OpenJDK, e.g., jdk9u jdk9, use jcheck to check the content and commit message of each changeset that goes into the repo. See the jcheck page for more information about jcheck, and the OpenJDK Producing a Changeset page for the required format of commit messages.

OVERVIEW

OpenJFX is not presently enabled to use jcheck on the server, but we are working towards this as a goal. This work is tracked by JBS bug JDK-8145561. The three main benefits of using jcheck are:

...

All Committers are strongly encouraged to use jcheck to check their changeset before pushing. There should be no excuse for pushing a changeset with a mistake that that jcheck would have caught.

SETUP

There are three simple setup steps needed to enable running jcheck:

...

3. Create a .jcheck directory in your repo (e.g., the '9-dev/rt ' repo or 'tests' repo), and copy the following conf file there:

http://cr.openjdk.java.net/~kcr/jcheck/conf

RUNNING JCHECK

Once your you have done the above setup, you can run jcheck at any time.

To check all outgoing changesets the 'tip' changeset after you commit but before you push:

...

If any errors are reported, then you will need to correct them before you can push the changeset. If you are an MQ user, then you should already know how to fix up your changeset comment prior to pushing – it's easy. Otherwise, you can do the following:

If you only have a single, committed but unpushed changeset:

$ hg rollback   # NOTE: this only undoes the last hg operation that modified your repo
<fix any reported white-space problems>
$ hg commit
<enter a corrected commit message>

If you have multiple changesets, or if you have done another write operation, then you will need to save off your patches and redo them, either with a new clone of the repo or by stripping the unpushed changesets from your local repo. For this reason, you should run "hg jcheck" right after each "hg commit".