js-elisp / README

-*- org -*-

Jane Street Emacs utilities

Linux note: I couldn't get omake to install with FAM support
via opam or from source.  The only way it worked was via apt.

* Usage

** Normal usage at the office

Everyone should add one of the following lines to their .emacs file.

      (load "/j/office/app/emacs/prod/jane-elisp/elisp/jane/jane-defaults")
        loads libraries, sets variables according to our coding
        standards, and sets standard defaults which many users find

      (load "/j/office/app/emacs/prod/jane-elisp/elisp/jane/jane-common")
        leaves discretionary settings to the user.

** Beta testers

Beta-testers (thank you!) should add:

      (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-defaults")


      (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-common")

These are analogous to the above, but with the next release.

** At home

For use at home:
  - Choose a site-lisp directory S.
  - Clone the BitBucket repo into S/jane.
  - Add one of the following to .emacs:

      (load "S/jane/elisp/jane/jane-defaults")
      (load "S/jane/elisp/jane/jane-common")

[You will also need to build omake_server.exe to use Omake.compile.]

* Development

** At the office

To build omake_server.exe:

    hg clone
    cd ocaml-core-external
    hg clone ssh://hg2//hg/jane-elisp/test
    patch -p1 < test/ocaml-core-external.patch # CentOS 5 compat
    cd test # this directory
    jomake -j 8 .DEFAULT runtest

You can clone ocaml-core-external with ssh:// rather
than after you create an account and Sean gives
you access to his repo.  See
about setting up keys.

** Opam release

Our repo for opam is

- Work on omake-mode in
- When we're ready for a major release, copy from there to
- Create a new version in opam-repository/packages/omake-mode.N.N in our fork of opam-repository
- Issue a pull request to ocamlpro