Commit Graph

1378 Commits (master)

Author SHA1 Message Date
octachron 3e7de343e7 fix attribute examples in the manual 2020-03-27 17:12:23 +01:00
Xavier Leroy 466ed635e9
The manual is now hosted on ocaml.org (#9378)
* Point to ocaml.org for the other versions of the manual
* Remove mentions of caml.inria.fr

ocaml.org is now the only place to go.


* MacOS X is now called macOS; MacOS 9 is no more
* Update availability of dynamic loading of C stubs
* "website" is more common these days than "Web site"
2020-03-20 18:25:54 +01:00
Florian Angeletti 3dd86faa2c
Merge pull request #9357 from muskangarg21/makedepend
[Ocamldep] [TOOLS] : -nocwd argument to not include current dir to search path
2020-03-17 10:18:31 +01:00
Jérémie Dimino e54876a869
Add a new toplevel directive #use_output "<command>"
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
Co-authored-by: David Allsopp <david.allsopp@metastack.com>
2020-03-16 17:48:41 +00:00
muskangarg21 e0b31a6abc TOOLS: Ocamldep arg to not include current dir to search path 2020-03-16 01:00:08 +05:30
Nicolás Ojeda Bär 57d329e07b
Deprecate -annot (#2141)
* Move driver code from Cmt2annot to Read_cmt
* Move cmt2annot.ml into typing/
* make depend
* Use standard error handling
* Move specific logic to read_cmt
* Do not pass full cmt record as argument
* Better locations
* Emit .annot files produced from cmt data
* Remove direct calls to Stypes
* Deprecate -annot
* Changes
* make depend
* Adapt doc
* make -C tools depend
2020-03-13 12:59:34 +01:00
Florian Angeletti 1fd6dc077d
Fix font family in code snippet (#9334) 2020-02-27 09:29:53 +01:00
Florian Angeletti 23b9369a9b manual: reference, split expression grammar 2020-02-12 10:58:20 +01:00
Florian Angeletti c7b1fe8513
manual: a cautionary internal runtime API section (#9257) 2020-01-31 13:54:31 +01:00
Florian Angeletti 11b57a7027
Merge pull request #9157 from mkarutz/noalloc-master-lock-docs
Added [doesn't release the master lock] constraint to [@@noalloc] doc.
2020-01-30 13:56:01 +01:00
Malcolm Karutz 33347f87a2
Added forward reference to "master lock" 2020-01-30 10:44:16 +08:00
Gabriel Scherer b237282e97 Merge pull request #9270 from gadmm/doc_stack_overflow
Documentation: Stack_overflow is reliable, Out_of_memory is not.
(cherry picked from commit 84f62eee5d26efb936cde0e799b7aaa39e46c010)
2020-01-29 11:08:57 +01:00
Florian Angeletti dc56d71b53 types: allow class type paths in #t 2020-01-20 17:21:02 +01:00
Gabriel Scherer 5b1b8dad1a
Merge pull request #9169 from gasche/best-fit-manual
better documentation for the best-fit allocation policy
2019-12-11 10:01:12 +01:00
Gabriel Scherer 238e483eb8 better documentation for the best-fit allocation policy 2019-12-10 21:40:50 +01:00
Stephen Dolan ca98dd8aa2 manual bugfix 2019-12-09 12:50:17 +00:00
Stephen Dolan 0b1ca1b738 Add version annotation on custom_fixed_length in manual 2019-12-09 11:32:40 +00:00
Florian Angeletti 721c182dfc manual: changes and documentation 2019-12-06 10:09:21 +01:00
Florian Angeletti 442b7a55e0 manual: remove 'magical' prefixing 2019-12-06 09:52:22 +01:00
Florian Angeletti a936857719 manual: cutnames for exten.etex 2019-12-05 18:07:32 +01:00
Florian Angeletti b4abe25ae8 manual: add a hidden-aria=true attribute 2019-12-05 17:31:04 +01:00
Florian Angeletti 345cfb6a98 manual: make labels mandatory 2019-12-05 17:31:04 +01:00
Florian Angeletti 3a2e11e8ba Visible link on the left 2019-12-05 17:15:38 +01:00
Florian Angeletti f4c5373d58 manual: add links to section anchors 2019-12-05 17:15:38 +01:00
Malcolm A. Karutz 2989c5e459 Added [doesn't release the master lock] constraint to [@@noalloc] doc. 2019-12-03 14:55:45 +08:00
Nicolás Ojeda Bär c45bb6b995
Merge pull request #9150 from bwignall/typo
Fix some spelling typos
2019-11-29 18:19:53 +01:00
Brian Wignall 2cd1db7ae9 Fix some spelling typos 2019-11-29 10:17:38 -05:00
Florian Angeletti 9a7473c335 manual code example: no div inside pre 2019-11-28 11:46:22 +01:00
octachron d7916aae0b manual code examples: Daniel's tip for '"' and "'" 2019-11-28 11:46:08 +01:00
Florian Angeletti b768c0be59 Highlighting in the manual
* Replace caml-sl with the standard listings package
and ulem package
* update caml_tex to output nicer latex code
* simplify escaping in caml_tex
2019-11-28 11:45:08 +01:00
Florian Angeletti 3bd80fbb6e
Merge pull request #9139 from xavierleroy/manual-license
Relicense the user's manual under CC BY-SA
2019-11-27 09:24:56 +01:00
Florian Angeletti 020777843f manual: id and css styling for CC license logo 2019-11-26 14:35:16 +01:00
Gabriel Scherer 05f15cf215
Merge pull request #8820 from Drup/stringquot
Quoted extensions
2019-11-25 21:26:53 +01:00
Gabriel Radanne 6399c91343 Update manual/manual/refman/exten.etex
Co-Authored-By: Alain Frisch <alain@frisch.fr>
2019-11-25 14:26:54 +01:00
Xavier Leroy c7a09ddec4 Proper Hevea implementation of the \year macro
Instead of hard-wiring the current year in macros.hva,
use Hevea's `year` counter, as set by `xxdate.exe`.

Hevea treats `year` as a LaTeX counter, to be used as `\arabic{year}`.
pdflatex treats `\year` as a plain TeX counter, to be used as `\number\year`.

A macro definition is needed to hide the difference.  I went for the minimal
change.
2019-11-25 14:06:43 +01:00
Xavier Leroy b71933f13f Relicense the user's manual under CC-BY-SA
As discussed at the 2019-11-13 developers' meeting.
All authors of the manual agreed to the change of license.
2019-11-25 14:03:22 +01:00
Drup 6a715bd3fe Add quoted extensions to the manual. 2019-11-13 16:08:41 +01:00
Drup abc53d1a6e Annotate constant literals with the location of their content. 2019-11-13 16:08:40 +01:00
Bernhard Schommer 720d135d18
Remove redundancy. 2019-11-13 12:53:13 +01:00
Bernhard Schommer f3b65829f6
Added documentation for the no-float-const-prop option 2019-11-12 17:56:10 +01:00
Florian Angeletti e3f83d58dc manual: fix operator char classes 2019-11-06 16:03:24 +01:00
Gabriel Scherer 9a0ebc18d4
Merge pull request #8993 from gadmm/resource-safe-api-pt1
Resource-safe C interface, part 1 (the 4.10 backwards-compatibility edition)
2019-10-18 07:02:36 +02:00
Guillaume Munch-Maccagnoni d0f70f757a Resource-safe C interface for async callbacks
Introduce caml_process_pending_actions and
caml_process_pending_actions_exn: a variant of the former which does
not raise but returns a value that has to be checked against
Is_exception_value.

I keep the current conventions from caml_callback{,_exn}: For a
resource-safe interface, we mostly care about the _exn variants, but
every time there is a public _exn function I provide a function that
raises directly for convenience.

They are introduced and documented in caml/signals.h.

Private functions are converted to their _exn variant on the way as
needed: for internal functions of the runtime, it is desirable to go
towards a complete elimination of functions that raise implicitly.

Get rid of the distant logic of caml_raise_in_async_callback. Instead,
caml_process_pending_events takes care itself of its something_to_do
"resource". This avoids calling the former function in places
unrelated to asynchronous callbacks.
2019-10-17 20:14:19 +02:00
Florian Angeletti 8947a38b61
Merge pull request #1807 from mshinwell/pr1020-take-two
Rework of GPR#1020
2019-10-16 18:15:57 +02:00
Guillaume Munch-Maccagnoni aa13b8cc97 Document new behaviour and upgrade path (check_urgent_gc) 2019-09-28 02:09:55 +02:00
Daniel Bünzli 17ef076000 .ocamlinit: XDG base directory lookup. (#8834) 2019-09-25 13:50:25 +02:00
Nicolás Ojeda Bär 3aff5141fd Add a new -output-complete-exe option (#8872)
This option allows to build self-contained bytecode executable and is aimed to replace `-custom`. The main difference between the two is that executables produced by `-output-compete-exe` can be stripped.
2019-09-25 08:07:31 +01:00
Jeremie Dimino 2d31ebfc8b Add support for [@@immediate64]
Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2019-09-24 07:56:15 +01:00
Florian Angeletti cb11bcf50a
manual: move pattern open out of the extension chapter (#8950)
* move the grammar description to the pattern section of the language reference
* add a small example in the module chapter of the tutorial
2019-09-20 10:19:18 +02:00
Gabriel Scherer 4c303cc88a Merge pull request #8826 from glondu/4.08-spelling-errors
Fix spelling errors reported by Lintian

(cherry picked from commit c808ce7068f3e31975594bcd5e6a41dceab3a80e)
2019-07-29 08:36:53 +02:00
Jacques-Henri Jourdan 78de99ecc2 Xavier Clerc's remarks. 2019-07-16 13:42:04 +02:00
Jacques-Henri Jourdan 593f94055a Dynlink support for ocamldebug
This commit adds dynlink support for ocamldebug. As a side effect, it also:
  - factorizes the various functions searching for a code fragment into one,
    called [caml_find_code_fragment];
  - removes the [caml_register_code_fragment], which does not seem to
    be used anywhere, and which clearly should not be used by external code.
2019-07-16 10:52:48 +02:00
Florian Angeletti f6f99c7715
Merge pull request #8763 from dra27/more-pervasives-refs
Rename remaining references to Pervasives to Stdlib
2019-07-09 18:00:25 +02:00
Alejandro da87dbd64a Format trivial fix 2019-07-07 22:48:16 -04:00
Florian Angeletti 458ea23751
Merge pull request #8790 from Octachron/test_case_collision
manual testsuite: case-insensitive name collisions
2019-07-05 15:51:12 +02:00
Florian Angeletti 9102f6a2f7 manual: test case-insensitive collisions 2019-07-05 09:34:02 +02:00
Florian Angeletti 781f71480b manual: restore ocamldep chapter 2019-07-02 18:44:18 +02:00
Florian Angeletti 2c9bf2ad12 manual: restore spacetime chapter 2019-07-02 18:10:30 +02:00
Florian Angeletti 4003788838 manual: fix broken links
(cherry picked from commit ffe6af917e4fe5ba20114d4bd36bebfc5851cfd9)
2019-06-30 10:05:41 +01:00
David Allsopp adfa5f9775 Tweak the default open sentence 2019-06-26 18:11:58 +01:00
David Allsopp 3e4c9f238a Choose a better example for external
Pervasives.input has never been a primitive (it was always unsafe_input)
- string_of_int has the benefit of being declared external.
2019-06-26 18:11:58 +01:00
David Allsopp 7c2284eda3 Rename references to Pervasives to Stdlib 2019-06-26 18:11:58 +01:00
Guillaume Munch-Maccagnoni 6a6f34e483 Fix typographic issues in the doc of new modules (#8744)
* Fix typographic issues in the doc of new modules

No change entry needed
2019-06-26 19:03:15 +02:00
Damien Doligez 4820d299fc manual: recover compatibility with case-insensitive file systems 2019-06-25 15:36:53 +02:00
Ian Zimmerman 466950b48f Stop talking about Pervasives in core library documentation 2019-06-23 17:18:58 +01:00
Cedric Cellier 70327c1607
Update intf-c.etex
Fix typo
2019-06-20 09:53:50 +02:00
Gabriel Scherer 010d94cae2
Merge pull request #2309 from TheLortex/runtime-variant-path
Add -noruntime option
2019-06-19 16:12:28 +02:00
Lucas Pluvinage 198d650245 without-runtime: cosmetic tweaks 2019-06-11 10:06:56 +02:00
JPR 6dc59549ce Fixing misspellings 2019-05-21 10:23:27 +02:00
octachron e7c72ed709 multi-indices for extended indexing operators 2019-05-13 15:26:49 +02:00
Lucas Pluvinage e61263c0ac Introduce the -without-runtime option. 2019-05-06 14:35:57 +02:00
Gabriel Scherer f845abefc9
Merge pull request #8593 from Octachron/manual_opam
manual: update references to toplevel improvements
2019-04-23 21:50:55 +02:00
Florian Angeletti 0701086b17 manual: update reference to improved toplevels 2019-04-07 22:10:14 +02:00
Florian Angeletti c27e0bdab9 manual: fix tests 2019-04-07 20:25:31 +02:00
Nicolás Ojeda Bär 933539380d
Merge pull request #8590 from arbipher/patch-1
Update comp.etex
2019-04-06 20:00:23 +02:00
Oxana Kostikova ac94a6546a Add .cmt* format description (#8538) 2019-04-06 19:57:05 +02:00
Weng Shiwei f8182797e2
Update README.md
The name of the directory is `library`
2019-04-06 13:45:41 -04:00
Weng Shiwei dbadf5fd11
Update comp.etex
replace `=` by `:` in declaring the type for a record
p.s. This warning doesn't occur in my test on OCaml 4.07.0
2019-04-06 13:33:18 -04:00
Florian Angeletti cd0933f0e8
Merge pull request #8515 from Octachron/reexport_constraint
manual: precise constraints on reexported types
2019-03-19 17:34:21 +01:00
Nicolás Ojeda Bär fe83737cbb dynlink: add doc about -linkall 2019-03-18 16:55:16 +01:00
Jérémie Dimino c413136fa3 Delete otherlib/{graph,win32graph} (#2318)
The Graphics library is now distributed as a separate package.
The sources are at https://github.com/ocaml/graphics .

Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2019-03-18 15:05:57 +01:00
Stephen Dolan 4f03a1467d
Merge pull request #2293 from stedolan/named-value-const
Make caml_named_value return a const value*
2019-03-18 09:45:02 +00:00
Florian Angeletti d0b47176ca manual: precise constraint on reexports 2019-03-17 22:03:52 +01:00
Florian Angeletti 798dc35c9e
manual: refresh moduleref macro (#8508) 2019-03-16 20:47:20 +01:00
Mark Shinwell 2cc1ea26b9 Remove gprof support (#2314)
This commit removes support for gprof-based profiling (the -p option to ocamlopt).  It follows a discussion on the core developers' list, which indicated that removing gprof support was a reasonable thing to do. The rationale is that there are better easy-to-use profilers out there now, such as perf for Linux and Instruments on macOS; and the gprof support has always been patchy across targets. We save a whole build of the runtime and simplify some other parts of the codebase by removing it.
2019-03-16 19:56:53 +01:00
Mark Shinwell 36c163248d Remove support for compiler plugins (#2276)
After consultation on the core developers' list I am proposing this patch to remove support for compiler plugins.

The main motivations for removing compiler plugins are:
- They are a potential security risk.
 - They increase the complexity of the build system and make maintenance of the Dynlink libraries more difficult (although actually, this complexity could probably be reduced after #2268 is merged).
 - Many applications of plugins should be able to be expressed by building custom compiler drivers that link against compilerlibs.

* Remove compiler plugins and hooks
* Add new function Dynlink.unsafe_get_global_symbol but keep it outside the documented API.
* Remove otherlibs/dynlink/nodynlink.ml
* Update Changes
2019-03-13 11:46:37 +01:00
Oxana Kostikova f5ab75bd63 MPR#7548 Add an example of using the printf function to the manual (#2272)
* Creating a new section in the first chapter of the manual

* Add an introduction of custom printer for int

* Add an easy example of %a combinator

* Add an example of using the printf function on complex data structure
2019-03-13 10:49:45 +01:00
Stephen Dolan 9f0bebf7f7 Make caml_named_value return a const value*.
This commit just adds "const" in several places.
2019-03-12 12:07:04 +00:00
Jérémie Dimino 705054b346 Delete the vmthreads library (#2289)
* Delete the deprecated vmthreads library

It was deprecated in 4.08.

* Remove the byte/native argument of init_path

It is no longer necessary.

* Error out when passing --{enable,disable}-vmthreads to ./configure

Signed-off-by: Jeremie Dimino <jeremie@dimino.org>
2019-03-11 19:38:16 +01:00
Ulugbek Abdullaev 8b1fda569d Added tutorial on Lazy expressions to tutorial section of manual (#2273)
* Added tutorial on Lazy expressions to the tutorial of manual
* Modified tutorial on Lazy expressions to make it easier to understand
* Add small modifications in wording and a better lazy pattern matching example
* Add minor modification
* Change wording regarding <lazy> as a display of value
* Change a word
* Append Changes to mention the added tutorial
* Add GPR number
2019-03-05 21:51:30 +01:00
Gabriel Scherer cf5b0ab572 manual: remove duplicate table of contents in the 'objects' chapter of the tutorial
(report by Daniel Bünzli)
(no change entry needed)
2019-03-04 17:34:13 +01:00
Florian Angeletti 54d5877834
manual: add compilerlibref to release target (#2253) 2019-02-18 09:37:13 +01:00
Gabriel Scherer 24b240c852 ocamldoc doc: fix the URL of the graphviz project
report by Frédéric Blanqui in MPR#7921.
2019-02-14 16:21:03 +01: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
Florian Angeletti 672b75e680 manual: move short object copy notation to core 2019-02-04 17:11:04 +01:00
Leo White 3dac696197
Some changes to documentation of let operators (#2206) 2019-01-02 11:59:45 -05:00
Florian Angeletti e8d4324ee6
documentation: use Bigarray consistently (#2208) 2018-12-20 18:46:54 +01:00
Florian Angeletti cbd0753ec6
manual: move lazy pattern to core (#2198) 2018-12-14 17:40:43 +01:00
Kevin Ji 698097a0fd
manual: Fix typo in "Local substitution declarations" 2018-12-11 23:08:08 -05:00
Florian Angeletti d3a4cba53b
Merge pull request #2187 from Octachron/exception_match_doc
manual: document exception A | exception B
2018-12-10 15:44:38 +01:00