Ekdohibs
/
ocaml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HACKING.adoc enhancements (#1436) 

HACKING.adoc enhancements

Typo fix and CI-related updates.
Fix info about email notifications
master
Sébastien Hinderer 2017-10-20 17:04:46 +02:00 committed by Gabriel Scherer
parent 8d7d40e407
commit ac8f8995e0
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
HACKING.adoc
View File

@ -109,8 +109,8 @@ Parses source files and produces an Abstract Syntax Tree (AST)
link:parsing/HACKING.adoc[].
The logic for Camlp4 and Ppx preprocessing is not in link:parsing/[],
but in link:driver/[], see link:driver/pparse.mli[],
link:driver/pparse.mli[].
but in link:driver/[], see link:driver/pparse.mli[] and
link:driver/pparse.ml[].
==== Typing -- link:typing/[]
@ -271,26 +271,39 @@ PR.
You do not need to be an INRIA employee to open an account on this
jenkins service; anyone can create an account there to access build
logs, enable email notifications, and manually restart builds. If you
would like to do this but have trouble doing it, please contact Damien
Doligez or Gabriel Scherer.
logs and manually restart builds. If you
would like to do this but have trouble doing it, please email
ocaml-ci-admin@inria.fr
==== Running INRIA's CI on a github Pull Request (PR)
To be notified by email of build failures, you can subscribe to the
ocaml-ci-notifications@inria.fr mailing list by visiting
https://sympa.inria.fr/sympa/info/ocaml-ci-notifications[its web page]
If you have suspicions that a PR may fail on exotic architectures
(it touches the build system or the backend code generator,
==== Running INRIA's CI on a publicly available git branch
If you have suspicions that your changes may fail on exotic architectures
(they touch the build system or the backend code generator,
for example) and would like to get wider testing than github's CI
provides, it is possible to manually start INRIA's CI on arbitrary git
branches by pushing to a `precheck` branch of the main repository.
branches even before opening a pull request as follows:
This is done by pushing to a specific github repository that the CI
watches, namely
link:https://github.com/ocaml/precheck[ocaml/precheck]. You thus need
to have write/push/commit access to this repository to perform this operation.
1. Make sure you have an account on Inria's CI as described before.
Just checkout the commit/branch you want to test, then run
2. Make sure you have been added to the ocaml project.
git push --force git@github.com:ocaml/precheck.git HEAD:trunk
3. Prepare a branch with the code you'd like to test, say "mybranch". It
is probably a good idea to make sure your branch is based on the latest
trunk.
(This is the syntax to push the current `HEAD` state into the `trunk`
reference on the specified remote.)
4. Make your branch publicly available. For instance, you can fork
OCaml's GitHub repository and then push "mybranch" to your fork.
5. Visit https://ci.inria.fr/ocaml/job/precheck and log in. Click on
"Build with parameters".
6. Fill in the REPO_URL and BRANCH fields as appropriate and run the build.
7. You should receive a bunch of e-mails with the build logs for each
slave and each tested configuration (with and without flambda) attached.
Happy Hacking!