janestreet / iron

Jane Street code review system

Iron is Jane Street’s internal code review tool.

For more on the design of iron, see the following blog posts:

• https://blog.janestreet.com/code-review-that-isnt-boring/
• https://blog.janestreet.com/scrutinizing-your-code-in-style/
• https://blog.janestreet.com/ironing-out-your-release-process/
• https://blog.janestreet.com/putting-the-i-back-in-ide-towards-a-github-explorer/

A key design decision was to review diffs rather than patches:

• https://blog.janestreet.com/designing-a-code-review-tool-part-2-patches-or-diffs/
• https://blog.janestreet.com/patch-review-vs-diff-review-revisited/

We no longer release the code of Iron, and do not expect that will change. It was never possible to run outside of Jane Street, and is not plausible that it ever will, due to dependencies on many aspects of our internal environment.

iron's Issues

More configurable remote mercurial server

Right now, it seems that the remote mercurial repositories are hardcoded to have "hg" as the host with "hg" as a path. It would be nice if this host and path combination were configurable.

In the module Remote_repo_path,

let family t =
  match t with
  | Ssh { host = "hg"; path } ->
    (match List.map (Abspath.to_list path) ~f:File_name.to_string with
     | "hg" :: family :: _ -> Some family
     | _ -> None)
  | File _ | Ssh _ -> None
;;```

Code review from command line

After look at https://blog.janestreet.com/putting-the-i-back-in-ide-towards-a-github-explorer/

wonder if that cli is avaliable.

I'm part of GNOME foundation where we recently we migrated to gitlab

https://gitlab.gnome.org/GNOME/

We get an improvement from gitlab visual cool code review:

https://gitlab.gnome.org/GNOME/gnome-builder/merge_requests/49

but as me, many ones are terminal hackers, and review code from command line would be great

Is it possible to point out the code or help to release some open source part of it?

Build instructions

I'd love to have some build instructions for Iron.

I want to try Iron and see if it's something my team could benefit from, but I'm not an Ocaml guy and trying to build this is baffling me.

Module dependency error when building master

I had to install a few packages using opam, but otherwise I simply have a fresh clone of the iron repo. I tried to make clean; make but it failed after a bunch of seemingly OK output. The failure message is:

Module Iron_command_rpc_intf in directory _build/default/public depends on Iron.
This doesn't make sense to me.

Iron is the main module of the library and is the only module exposed 
outside of the library. Consequently it should be the one dependending 
on all the other modules in the library.

My system:

• Mac OS 10.12.6
• opam 1.2.2
• ocaml 4.05.0
• jbuilder 1.0+beta14

Both ocaml and opam were installed with brew (version 1.3.6-8-g15096e7).