Merge pull request #40 from tmcgilchrist/fixes

Add Github url to help text

Author: tmcgilchrist

README.md

@@ -1,7 +1,7 @@
 opam-compiler
 =============
 
-A WIP opam plugin to manage compiler installations.
+An opam plugin to manage compiler installations.
 
 It can be used to create switches from various sources such as the main
 repository, ocaml-multicore, or a local directories. It can use tag names,
@@ -16,17 +16,20 @@ compiler in place.
 Installing
 ----------
 
-This is an opam plugin. Once installed, it will be available globally using
-`opam compiler ARGS`. To install it, pin it to get a development version:
+This is an [opam plugin](https://opam.ocaml.org/doc/Manual.html#Plugins).
 
-    opam pin add opam-compiler 'git+https://github.com/emillon/opam-compiler.git'
+Once installed, it will be available globally using `opam compiler ARGS`.
+To install it, either run `opam install opam-compiler` to use the opam-repository
+version or pin it to get a development version:
+
+    opam pin add opam-compiler 'git+https://github.com/ocaml-opam/opam-compiler.git'
 
 Creating a switch
 -----------------
 
 `opam compiler create` is a wrapper around `opam switch create` that will use a
-custom. The documentation can be found [here](doc/create.txt), but as an
-example, the following is recognized:
+custom OCaml compiler. The documentation can be found [here](doc/create.txt), but as an
+example, the following is recognised:
 
     # Use this pull request number
     opam compiler create '#1234'
@@ -51,3 +54,6 @@ which will create a vanilla compiler. It is possible to override this:
 
     # Just build the bytecode compiler from a pull request
     opam compiler create '#1234' --configure-command "./configure --disable-native-compiler"
+
+    # Build the native compiler with flambda and frame pointers
+    opam compiler create '#1234' --configure-command "./configure --enable-flambda --enable-frame-pointers"

doc/create.txt

@@ -19,6 +19,9 @@ DESCRIPTION
        Github pull request (short form)
            #number (repo defaults to "ocaml/ocaml")
 
+       Github url
+           https://github.com/user/repo/pull/1
+
 ARGUMENTS
        SOURCE (required)
            Where to fetch the compiler.

lib/cli.ml

@@ -131,6 +131,7 @@ module Create = struct
       `I
         ( "Github pull request (short form)",
           "#number (repo defaults to \"ocaml/ocaml\")" );
+      `I ("Github url", "https://github.com/user/repo/pull/1");
     ]
 
   let term =

test/cram/create.t

@@ -19,6 +19,13 @@ Github PR numbers are also accepted:
   Run: OPAMCLI=2.0 opam pin add --switch ocaml-ocaml-1234 --yes ocaml-variants git+https://github.com/user-ocaml-ocaml-1234/repo-ocaml-ocaml-1234#branch-ocaml-ocaml-1234
   Run: OPAMCLI=2.0 opam switch set-base --switch ocaml-ocaml-1234 ocaml-variants
 
+Github source urls are also accepted:
+
+  $ opam-compiler create --dry-run 'https://github.com/ocaml/ocaml/pull/10831'
+  Run: OPAMCLI=2.0 opam switch create ocaml-ocaml-10831 --empty --description "[opam-compiler] ocaml/ocaml#10831 - Title of ocaml-ocaml-10831"
+  Run: OPAMCLI=2.0 opam pin add --switch ocaml-ocaml-10831 --yes ocaml-variants git+https://github.com/user-ocaml-ocaml-10831/repo-ocaml-ocaml-10831#branch-ocaml-ocaml-10831
+  Run: OPAMCLI=2.0 opam switch set-base --switch ocaml-ocaml-10831 ocaml-variants
+
 An explicit configure step can be passed:
 
   $ opam-compiler create --dry-run USER/REPO:BRANCH --configure-command "./configure --enable-x"