Commit Graph

30 Commits (master)

Author SHA1 Message Date
Nicolás Ojeda Bär 540996d21e Remove Spacetime 2020-10-08 20:28:12 +02:00
Enguerrand Decorne f3ee9e3beb add manual page for the instrumented runtime 2020-07-08 03:13:56 +02:00
Florian Angeletti 721c182dfc manual: changes and documentation 2019-12-06 10:09:21 +01:00
Florian Angeletti 2c9bf2ad12 manual: restore spacetime chapter 2019-07-02 18:10:30 +02:00
Damien Doligez 4820d299fc manual: recover compatibility with case-insensitive file systems 2019-06-25 15:36:53 +02:00
Weng Shiwei f8182797e2
Update README.md
The name of the directory is `library`
2019-04-06 13:45:41 -04:00
Fourchaux 1946594bd7 Fixing typos in various files (#2246)
Note: Typos found with https://github.com/codespell-project/codespell

Here is the (semi-manual) command used to get (and correct) the typos:

$ codespell -i 3 -w --skip=".png,.gif,./ocaml/boot,./ocaml/.git,./ocaml/manual/styles,./ocaml/manual/manual/htmlman" -L minimise,instal,contructor,"o'caml",cristal,pres,clos,cmo,uint,iff,te,objext,nto,nd,mut,upto,larg,exten,leage,mthod,delte,tim,atleast,langage,hten,iwth,mke,contant,succint,methids,eles,valu,clas,modul,que,classe,missings,froms,defaut,correspondance,differents,configury,reachs,cas,approche,normale,dur,millon,amin,oje,transfert
2019-02-13 14:04:56 +01:00
Maxime Flin 74e3b9a215 Change verbatim to caml_example in documentation (#2105)
* Add paragraph in manual's readme about signature option in caml_example env. Change verbatim env to caml_example.
2018-10-15 22:19:46 +02:00
Perry E. Metzger 6857b9afd8 manual/README.md: remove claim that "ed" is needed for the install 2018-09-05 16:47:07 -04:00
Florian Angeletti 4be6cafcc3
manual, code example preprocessor : full conversion to compiler-libs (#1863)
* manual tools: use toploop directly in caml_tex2
* manual tool: improved error messages
* manual: always print errors and warnings
* fix nefarious interaction with GPR#1120
* move manual/tools/caml_tex2 to tools/caml_tex
* Basic text for caml-tex
2018-07-25 10:38:08 +02:00
Gabriel Scherer 2fa1dde9d9 manual: rewrite forgotten references to 'pdfmanual' (now 'manual') 2018-06-26 11:17:40 +02:00
Sébastien Hinderer 28c337fecb manual/README.md: stop mentionning the DVI manual
This is a follow-up to commit 2f0d65c7ee
in GPR #1842.
2018-06-26 07:25:22 +02:00
steinuil 3b74227b61 manual: fix typo in README 2018-05-18 20:27:35 +02:00
octachron f40d1d1c99 Add ellipsis to caml_example pseudo-env 2018-05-06 20:38:19 +02:00
Gabriel Scherer 39e56ac9c0 manual/README.md: minor rendering bug 2018-01-05 22:36:29 +01:00
octachron 4997f9239a manual: new consistency test for cross-references 2018-01-04 12:46:57 +01:00
octachron c183f0cb8e manual: update after the separation of Num 2017-08-21 14:09:22 +02:00
octachron 488dbd9fe3 GPR#1194: update Changes and manual/README.md 2017-06-07 18:31:03 +02:00
octachron 80b394c6c7 MPR#7551: allow caml_example to omit final ";;"
This commit makes it possible to omit the final ";;" in a caml_example
environment.

By default, this final ";;" is still mandatory. A new command line
option "-implicit-stop" makes it optional globally.

This global setting can be overrided locally by adding an optional
argument to the environment:

* [toplevel] makes the ";;" mandatory
* [verbatim] makes it optional

The tutorial part of the manual is configured to use the mandatory ";;"
mode globally for the sake of consistency whereas the language extension
section uses the new optional ";;" mode.
2017-06-07 16:44:28 +02:00
Mark Shinwell 866357b769 Spacetime manual page (#884) 2016-12-14 13:14:21 +00:00
Stephen Dolan a35c6117e6 Instrumentation for american fuzzy lop (afl-fuzz) (#504) 2016-12-06 17:18:04 +01:00
octachron eae2b1337b Activate caml_example for refman/exten.etex 2016-11-28 21:02:22 +01:00
octachron f28422b601 Manual: unify compilers/toplevel options
This commit creates a file unified-options.etex which regroups at
source level the description of the compilers and toplevel options.
Difference of options between native/bytecode compilers and toplevel
are handled via conditional tex macros.
2016-11-05 16:04:04 +01:00
octachron 9d7ef6b61e Manual tools: guarded caml_example environment
This commit modifies the manual tool caml_tex2 to catch the status of
the output and raises an error in case of unexpected error of warning
message. Expected errors or warnings must be now marked explicitly.
There are two options to mark these expected errors or warnings:
The first option is to use the new optional parameter of the
`caml_example` environment, e.g.

\begin{caml_example}[warning=3]
  String.capitalize "a word";;
\end{caml_example}

or for an error:

\begin{caml_example}[error]
  1 +. 3.;;
\end{caml_example}

The second option is to use `[@@expect ..]` attribute before `;;` to
override locally the global expected status output:

\begin{caml_example}
  1 + 2 ;;
  1 +. 3. [@@expect error];;
  String.capitalize [@@expect warning 3];;
  3 + 4 ;;
\end{caml_example}

Note that the two options can be combined together, e.g

\begin{caml_example}[error]
  1 +. 3.;; (* an error is expected here *)
  1. +. 3. [@@expect ok] ;;
  1 + 3. ;; (* an error is still expected here *)
\end{caml_example}
2016-09-02 01:01:33 +02:00
octachron ee24c7646d Manual: extended readme 2016-07-14 00:06:19 +02:00
Sébastien Hinderer cff9c4e624 Fix a few typos. 2016-05-03 17:23:37 +02:00
Gabriel Scherer 57ab1f1055 manual build: have 'make all' run 'make tools' first 2015-11-29 08:41:31 +01:00
François Bobot 24299525a8 Some current shortcoming of the manual compilation 2015-11-23 15:02:53 +01:00
François Bobot fe318c9719 Simplify a little the build of the manual
- the `release` link is not needed since we know where the ocaml sources are
  - use make builtin function `abspath` on the root directory
  - the `LD_LIBRARY_PATH` and `DYLD_LIBRARY_PATH` are automatically set
    to the required value if unset
2015-11-20 11:23:35 +01:00
Gabriel Scherer 0e85619baa PR#6895: add a README for the documentation
This helpful guide to building the manual has been written by John
Whitington. I (Gabriel Scherer) converted it to markdown format for
Github users convenience.

git-svn-id: http://caml.inria.fr/svn/ocamldoc/trunk@16193 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2015-06-30 08:05:29 +00:00