OpenSolaris

About this site

This is a site which enables OpenSolaris developers to post and share code reviews. Code review is an essential function within the community and is an essential part of our quality strategy.

Send feedback to website-discuss@opensolaris.org

Ongoing Enhancements

• RSS feed of new codereviews (Dan Price)
• Auto-post to the site from webrev (Vladimir Kotal)

We're open to further enhancements, including further improvements to webrev, gathering codereview feedback, and other possibilities. Feel free to pick up any open webrev related bugs in the solaris/consolidation/os-net-tools category via the sponsorship program.

Account Setup

In order to use this system, you must have:

• An opensolaris.org account
• A valid SSH key on file (for more on SSH keys and OpenSolaris, see opensolaris.org SSH Key Help).

Provided these requirements are met, an account should be automatically activated for you on this site within 10 minutes of the requirements being fulfilled; you can check to see if your account exists by testing if http://cr.opensolaris.org/~username exists. Here is how to use it:

• Your account's contents are visible at http://cr.opensolaris.org/~username/.
• Accounts have scp, sftp, and rsync access only.
• Use scp -r, rsync -avz, or the webrev script to upload files. Each account has a .trash folder; use sftp or webrev to move directories you want to trash to the .trash folder; a cron job will come along once an hour to nuke them (n.b. this is a workaround for the nuisance that sftp doesn't implement a recursive delete).
• The webrev script is delivered by the SUNWonbld package. This can be downloaded from the OpenSolaris Download Center or built from the ON repository directly.
• Note that If your user account name is different from your opensolaris.org identity, you will need to create a mapping in your ssh configuration. Setup your ~/.ssh/config like this:

  Host cr.opensolaris.org
    User your-opensolaris.org-username
  	

• No shell login is permitted.
• Account meta-data such as your SSH public key are backed up, but your webrevs are not. In the event that we have data loss, you will need to re-upload your webrevs; we'll try to keep you informed of any problems. To stay informed, sign up for website-discuss@opensolaris.org.

Examples

Posting a review

Let's say you would like to upload a webrev generated from the changes present in repository named fix-123456.onnv. To generate and upload the webrev use the built-in upload capability of webrev script as follows:

$ cd fix-123456.onnv; webrev -O -U
   SCM detected: mercurial
 File list from: hg-active -p ssh://anon@hg.opensolaris.org//hg/onnv/onnv-gate
... Done.
      Workspace: /export/home/me/Workspaces/fix-123456.onnv (at e4f45a0bfbb0)
Compare against: ssh://anon@hg.opensolaris.org//hg/onnv/onnv-gate (at
e4f45a0bfbb0)
      Output to: /export/home/me/Workspaces/fix-123456.onnv/webrev
   Output Files:
	usr/src/foo/bar.ksh
		 patch cdiffs udiffs wdiffs sdiffs frames ps old new
	...
 Generating PDF: Done.
     index.html: Done.
 Syncing webrev: Done.

The webrev will be uploaded to remote directory http://cr.opensolaris.org/~username/fix-123456.onnv/. To make this work, you need to setup an entry for cr.opensolaris.org in your ~/.ssh/config like this:

Host cr.opensolaris.org
  Hostname cr.opensolaris.org
  User username
	

For more information on remote webrev upload, see webrev(1) manual page.

Deleting a review

To delete remote webrev use the built-in deletion functionality of webrev script:

$ cd fix-123456.onnv; webrev -D
   SCM detected: mercurial
 File list from: hg-active -p ssh://anon@hg.opensolaris.org//hg/onnv/onnv-gate
... Done.
Removing remote: Done.
	

This will rename remote webrev directory fix-123456.onnv under the .trash directory. For more information on remote webrev upload, see webrev(1) manual page.

Uploading a directory

In case you need to upload generic data (log files, ARC case proposals, etc.) use the following command to upload a directory containing the data:

$ scp -r generic_data username@cr.opensolaris.org:
Enter passphrase for key '/home/me/.ssh/id_dsa':
foo                  100% |*****************************|  1410       00:00
bar                  100% |*****************************|  1942       00:00
	

As an alternative, rsync can be used:

$ cd generic_data
$ rsync -avz . username@cr.opensolaris.org:generic_data
Enter passphrase for key '/home/me/.ssh/id_dsa':
./
bar
foo

sent 175 bytes  received 92 bytes  48.55 bytes/sec
total size is 3352  speedup is 12.55
	

Note that SSH transport for rsync protocol is used. rsync has the speed advantage (over SCP/RCP protocol) and allows you to easily upload over and over.

Deleting a directory

$ echo "rename generic_data .trash/generic_data" | sftp
username@cr.opensolaris.org
Enter passphrase for key '/home/me/.ssh/id_dsa':
	

FAQ

I can't seem to contact cr.opensolaris.org or poll.opensolaris.org using ssh?

If you work for Sun, you'll need to either configure a SOCKS proxy for SSH or find a machine with so-called "Direct-Internet-Access." Contact your local IT person or someone who is knowledgeable in this area. The cr.opensolaris.org maintainers probably don't have the cycles to help you with this.

I still can't seem to contact cr.opensolaris.org, but I *can* connect to poll.opensolaris.org using ssh?

Something might be wrong with the site. Please send mail to website-discuss@opensolaris.org.

SSH connects, but I get prompted for a password, and not an SSH key passphrase...

For one reason or another, you might not have an account. Check to see if http://cr.opensolaris.org/~username/ exists. If not, see the requirements list in the Account Setup section.

Usage Rules / Terms of Use

• Materials posted must be related to codereviews of OpenSolaris-related material; it is acceptable to post related meta-data, such as bug reports, provided you have the appropriate authority to do so.
• Personal home pages, images, pr0n or other materials are NOT permitted.
• Contributors internal to Sun should remember to use "webrev -O". This ensures that links to bug reports, etc. are correct.
• Old codereviews may be automatically deleted to make room if disk space becomes limited.
• Materials must not be considered confidential or private to whatever company or organization you work for. google and the whole world will be able to see what you post.
• A small javascript tracker may be auto-appended to all html pages served by the site. There have been technological problems with this, so it may not always be enabled. Access to the analytics is available by request.
• The site authors reserve the right to publish a master list of codereviews present on cr.opensolaris.org. An opt-out facility is provided: create a file called opt-out either in the base directory of the codereview (to opt-out for a specific review), or in your home directory (to opt-out for all reviews).
• Additional Terms of Service may apply: see the "Terms of Use" link at the bottom of this page.
• No guarantee of "uptime," availability or technical support is implied or stated. The site is operated by one individual and support is on a best-effort basis.