Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

various problems with ocaml 3.09 and the docs #3830

Closed
vicuna opened this issue Nov 3, 2005 · 4 comments
Closed

various problems with ocaml 3.09 and the docs #3830

vicuna opened this issue Nov 3, 2005 · 4 comments
Assignees
@garrigue
Labels
bug documentation

Comments

@vicuna
Copy link

vicuna commented Nov 3, 2005

Original bug ID: 3830
Reporter: administrator
Assigned to: @garrigue
Status: closed (set by @garrigue on 2007-11-30T01:51:29Z)
Resolution: fixed
Priority: normal
Severity: minor
Category: documentation
Related to: #8336
Monitored by: "Hendrik Tews"

Bug description

Hi,

I would like to bring the following points to your attention:

  • Wrong error message in:

    101> echo "5;;" > a.ml
    102> /usr/local/stow/ocaml-3.09.0/bin/ocamlopt -c a.ml
    103> /usr/local/stow/ocaml-3.09.0/bin/ocamlopt -pack -o c.cmx a.cmx
    File a.cmx was not compiled with the `-pack C' option

should probably be `-for-pack C'

  • true, false, (), and :: can still be used as constructors,
    although they have been deleted from constr-name already in
    3.07

  • libref/Unix and libref/UnixLabels contain different information
    for instance for

    • write
    • Locking
    • tm_sec

  • the notes in bug warning 40: fix missing wrap_printing_env #1893 suggest the optlabel problem has been
    fixed. However, optlabel is still used in the explanation of
    function types (in 6.4). The statement about ambiguities in
    Section "Naming labels" in 6.1 and the way labels appear in the
    grammar, namely as sequence of three tokens, seems slightly
    contradictory.

  • in the txt version all apostrophes appear as "-", eg

                       Documentation and user-s manual

    #-a-;;

    • : char = -a-

    val sort : -a list -> -a list =

    Character literals are delimited by - (single quote) characters. The two

  • the txt version contains lots of spurious
    0.5cm
    lines

  • some html files contain very long lines, eg libref/StdLabels.Array.html

  • sometimes the grammar tables are shifted against each other, eg
    in "Variant types" manual012.html, manual015.html, "Class
    expressions" manual017.html

Bye,

Hendrik
@vicuna
Copy link
Author

vicuna commented Nov 16, 2005

Comment author: administrator

Hello, I have solved some of your concerns, but not all.

Hi,

I would like to bring the following points to your attention:

  • in the txt version all apostrophes appear as "-", eg

                       Documentation and user-s manual

    #-a-;;

    • : char = -a-

    val sort : -a list -> -a list =

    Character literals are delimited by - (single quote) characters. The two

This is a silly bug in hevea, it is now corrected, thank you for reporting
the bug.

  • the txt version contains lots of spurious
    0.5cm
    lines
    Solved.
  • sometimes the grammar tables are shifted against each other, eg
    in "Variant types" manual012.html, manual015.html, "Class
    expressions" manual017.html

This originates from making several consecutive tables in place of one,
for the sake of page breaks in the .ps/.pdf manual. I have avoided
those breaks in the html version.

Besides, I had a look at your enhanced manual and shamelessly stole
the idea of links to non-terminal definition in grammars. This
feature can be added quite easily, without changing .tex source,
by a new style file for hevea.

You can have a look at the result at
http://pauillac.inria.fr/~maranget/htmlman/

As regards your query for a source distribution of the manual, I personnaly
see no problem about that. However, this implies legal and technical issues
that still need to be discussed here. I guess that the easiest way to do
so would be to grant (read) access to documentation sources through the CVS
web interface, as it is already the case for compiler sources.

--
Luc Maranget

@vicuna
Copy link
Author

vicuna commented Nov 16, 2005

Comment author: administrator

Half-open if I can say so, solved a few of the OP's concerns.
--LM 2005-11-16.

@vicuna
Copy link
Author

vicuna commented Nov 19, 2007

Comment author: @damiendoligez

for-pack: fixed as of 3.09.3
true, false, (), :: : won't fix; just don't use them as constructors
UnixLabels: fixed
optlabel: this is too complex for me; I'm assigning it to Jacques Garrigue
(and changing the category to documentation)

The other ones are already fixed, as far as I can tell.

@vicuna
Copy link
Author

vicuna commented Nov 30, 2007

Comment author: @garrigue

Attempted fixing the label/optlabel definitions, mainly by stating that they are only needed as lexical entities to disambiguate expressions, eventhough grammars in the manual use their expanded forms.

@vicuna vicuna closed this as completed Nov 30, 2007
@vicuna vicuna mentioned this issue Mar 14, 2019
Closed
@vicuna vicuna added the bug label Mar 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@garrigue garrigue

Labels
bug documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@garrigue @vicuna