summaryrefslogtreecommitdiff
path: root/manual
Commit message (Collapse)AuthorAgeFilesLines
* Factorize the build of the unprefixed stdliboctachron2018-02-122-63/+16
| | | | which is used by both ocamldoc and the reference manual.
* Minimal fix for the manual build pocessoctachron2018-02-123-59/+64
|
* Prefix the compilation unit names of all modules in the stdlibJeremie Dimino2018-02-121-7/+16
| | | | | | | | | | | | | | | | | | Except for the Camlinternal* modules and the new Stdlib module, all modules in the stdlib now compile to Stdlib__<module>. Pervasives is renamed to Stdlib and now contains a list of aliases from the long names to the short ones, so that from inside and outside the stdlib we can refer to the standard modules as just List or Stdlib.List rather than Stdlib__list. In order to avoid printing the long names in error messages and in the toplevel, the following heuristic is added to Printtyp: given a path Foo__bar, if Foo.Bar exists and is a direct or indirect alias to Foo__bar, then prefer Foo.Bar. A bootstrap step was required to replace Pervasives by Stdlib as the module opened by default.
* Fix minor typoYuriy Vostrikov2018-02-091-1/+1
|
* Improve wording in several places in the OCaml manual, mostly in chapterJim2018-01-253-44/+55
| | | | | 1. PR#7698
* s/an Unicode/a Unicode/David Allsopp2018-01-191-1/+1
|
* manual/README.md: minor rendering bugGabriel Scherer2018-01-051-3/+6
|
* manual: new consistency test for cross-referencesoctachron2018-01-047-3/+284
|
* Manual: fix obsolete reference to "curses.mli"Jakub Wilk2017-12-301-1/+1
|
* manual examples:decouple verbatim/toplevel styles (#1540)Florian Angeletti2017-12-213-18/+46
|
* manual, remove dangling referenceoctachron2017-10-271-3/+0
| | | | | This commit removes a dangling reference to the explicitly overriding method definition that was moved to the tutorial part of the manual.
* Add C stubs Unicode guidelines to manual (#1450)Nicolás Ojeda Bär2017-10-271-0/+141
| | | | Add C stubs Unicode guidelines to manual
* Update section 11.5 (differences between ocamlopt and ocamlc)Xavier Leroy2017-10-191-8/+30
| | | | Discuss FMA and also the issue from MPR#7271.
* Merge pull request #1344 from nojb/linscan_flag_manualGabriel Scherer2017-10-161-0/+8
|\ | | | | Add -linscan doc to manual
| * Add -linscan doc to manual and man pageNicolas Ojeda Bar2017-09-151-0/+8
| |
* | GPR#594, manual: new chapter on polymorphismFlorian Angeletti2017-10-165-37/+495
| | | | | | | | | | | | | | This commit adds a new chapter to the tutorial part of the manual, describing potential issues that can appear with polymorphic functions and types, and possible solutions or workarounds. The issues covered are, section-by-section: * weakly polymorphic types * polymorphic recursion * higher-ranked polymorphic function
* | Improved documentation of unboxed and noalloc attributesMarkus Mottl2017-10-111-15/+16
| |
* | PR#7363: start documentation headers at {1octachron2017-10-041-4/+4
| |
* | PR#7363, ocamldoc: implicit level 0 for titlesoctachron2017-10-031-2/+2
| | | | | | | | | | | | This commit makes the heading hierarchy of ocamldoc start at {0 rather than {1. This level {0 should be reserved for global titles, freeing the use of {1 for normal subtitles.
* | rename the configure-time safe-string options for clarityGabriel Scherer2017-10-021-2/+2
| | | | | | | | | | | | | | | | | | -(un)safe-string becomes -(no-)force-safe-string -(un)safe-string-default becomes -default-unsafe-string Config.safe_string (and Clflags.unsafe_string) keep their name for backward-compatibility, as well as the C define CAML_SAFE_STRING (which corresponds to -force-safe-string).
* | Allow first character of OCAMLPARAM to specify an alternative separatorFabrice Le Fessant2017-09-292-4/+14
| | | | | | | | The alternative separator must be in ":|; ,".
* | Change factor estimation equationLeonid Rozenberg2017-09-181-1/+1
| | | | | | | | Currently, the equation is rendered as (1/1 + f)<sup>d</sup>. I'm not certain if this will correctly render in HTML (apologies, but I don't have the capacity to check at the moment), but hopefully this PR will suffice.
* | Add support for qualified indexing operatorsoctachron2017-09-161-13/+12
| | | | | | | | aka `x.Module.Path.!(y)` and friends
* | Extended indexing operators (#1064)Florian Angeletti2017-09-154-4/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Extended indexing operators This commit adds extended indexing operators to the parser. For instance, ``` let (.%()) p (x,y) = p.( x ).( y ) ;; p.%(0,0) ``` Extended indexing operators name starts with a leading dot "." followed by an operator symbol, except "." or "<" and a sequence of any operators and must be closes with a couple of enclosing parentheses ( i.e. "()", "[]", "{}" ) and then an optional assignment operator "<-": * '.' dotsymbolchar symbolchar* '(' ')' ['<-'] * '.' dotsymbolchar symbolchar* '[' ']' ['<-'] * '.' dotsymbolchar symbolchar* '{' '}' ['<-'] Similarly, expressions of the form * expr_1 '.' dotsymbolchar symbolchar* '(' expr_2 ')' * expr_1 '.' dotsymbolchar symbolchar* '[' expr_2 ']' * expr_1 '.' dotsymbolchar symbolchar* '{' expr_2 '}' and * expr_1 '.' dotsymbolchar symbolchar* '(' expr_2 ')' '<-' expr_3 * expr_1 '.' dotsymbolchar symbolchar* '[' expr_2 ']' '<-' expr_3 * expr_1 '.' dotsymbolchar symbolchar* '{' expr_2 '}' '<-' expr_3 are desugared to * ('.' dotsymbolchar symbolchar* '(' ')' ) expr_1 expr_2 * ('.' dotsymbolchar symbolchar* '[' ']' ) expr_1 expr_2 * ('.' dotsymbolchar symbolchar* '{' '}' ) expr_1 expr_2 and * ('.' dotsymbolchar symbolchar* '(' ')' '<-' ) expr_1 expr_2 expr_3 * ('.' dotsymbolchar symbolchar* '[' ']' ) expr_1 expr_2 expr_3 * ('.' dotsymbolchar symbolchar* '{' '}' '<-' ) expr_1 expr_2 expr_3
* | Turn off warning 40 by default (#1333)Leo White2017-09-151-1/+1
|/ | | | * Turn off warning 40 by default
* Merge pull request #792 from sliquister/generalize-destr-subst2Leo White2017-09-151-8/+9
|\ | | | | Fixing the limitations on destructive substitutions
| * Teach Changes, ocamldoc and the manual about deep destructive substitutionsValentin Gatien-Baron2017-08-011-8/+9
| |
* | Merge pull request #1231 from Octachron/hello_κόσμοςFlorian Angeletti2017-09-131-0/+4
|\ \ | | | | | | Toplevel: only escapes bytes and not strings
| * | toplevel: only escapes bytes and not stringsoctachron2017-09-121-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Escaping strings when printing them in the toplevel has the disadvantage of mangling unicode text: ``` \# "한글";; - : string = "\237\149\156\234\184\128" ``` With this commit, strings are not escaped anymore, contrarily to bytes: ``` \# let cosmos = "κόσμος";; cosmos : string = "κόσμος" \# Bytes.of_string cosmos;; - : bytes = Bytes.of_string "\206\186\207\140\207\131\206\188\206\191\207\130" ``` This new behavior can be disabled dynamically by setting the environment variable OCAMLTOP_UTF_8 to false This change is not solely aesthetic: the mangling of unicode string may contribute to the impression of some OCaml newcomers that Ocaml has no support for unicode.
* | | Document that some warnings cannot be controlled by ocaml.warning.alainfrisch2017-09-121-0/+3
| | |
* | | Doc.alainfrisch2017-09-121-2/+0
| | |
* | | Documentation.alainfrisch2017-09-121-2/+3
| | |
* | | Add private extensible variantsLeo White2017-09-111-0/+36
| | |
* | | Minor rewordingXavier Leroy2017-08-221-5/+5
| | |
* | | manual: update after the separation of Numoctachron2017-08-214-50/+14
| | |
* | | Make clear "toplevel" = "REPL" in the TOC (#1276)Christophe Troestler2017-08-041-3/+3
| | |
* | | String_val: return 'const char *' when -safe-string is globally enabled (#1274)yallop2017-08-031-5/+11
| |/ |/|
* | Reference manual: re-add \\Vincent Jacques2017-07-241-1/+1
| | | | | | | | As noted by @Octachron
* | Reference manual: fix grammar in Language extensionsVincent Jacques2017-07-211-2/+2
| | | | | | | | No change entry needed
* | Reference manual: fix syntax errors in grammarVincent Jacques2017-07-211-3/+3
| |
* | Merge branch 'trunk' into string-unicode-escapesAlain Frisch2017-07-205-10/+35
|\ \
| * | Support 'let open' in class and class type expressions (#1249)Alain Frisch2017-07-202-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Support 'let open' in class and class type expressions. * Adapt ocamlprof. * Adapt ocamldoc. * Add tests. * Changelog. * Manual.
| * | merge 4.05 into trunkDamien Doligez2017-07-183-7/+15
| |\ \
| | * | Some tweaks for MPR#7557 (#1213)Damien Doligez2017-06-281-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * fall back to __secure_getenv when secure_getenv is not available * use secure_getenv for instrumented runtimes * documentation: warn against setting the setuid or setgid bits on custom bytecode executables
| | * | Manual: fix dead links in ocamldoc chapteroctachron2017-05-241-5/+6
| | | |
| | * | Fix typo in coreexamples.etexRob Blanco2017-04-041-1/+1
| | | |
| | * | Manual: fix link to Ast mapper moduleoctachron2017-03-311-2/+4
| | | |
| | * | PR#7497: manual, numbered tables of contentsoctachron2017-03-181-1/+1
| | | |
| | * | Respect OCAML_COLOR environment variable for deciding whether to use colorsHannes Mehnert2017-03-151-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since 4.03, OCaml supports coloring its messages to standard output and standard error, depending on the "-color" argument ({always,never,auto}). This commit adds support for the environment variable "OCAML_COLOR" (which value can as well be {always,never,auto}). The command line argument "-color" takes precedence, "OCAML_COLOR" is only taken into consideration if no "-color" is provided. The motivation for this is that the user should have control over coloring OCaml's output messages. OCamlbuild, a widely used build tool executes OCaml not under a tty (and OCaml does not colorize errors and warnings), which lead various packages use `color(always)` in their `_tags` files, which breaks with other (non-interactive) programs (i.e. editor helpers). Further discussion was done at https://github.com/ocaml/ocamlbuild/issues/87 and https://github.com/ocaml/ocaml/pull/1098.
| | * | Quoted string and extension nodes: manual clarificationGabriel Scherer2017-03-051-7/+21
| | | | | | | | | | | | | | | | | | | | This manual clarification is intended to lift up the misunderstanding that is the basis for #1066.