[Caml-list] [Mantis Bug Tracker] [OCaml 0005317]: Errors in OCaml manual on web, Section 1.8

[Caml-list] [Mantis Bug Tracker] [OCaml 0005317]: Errors in OCaml manual on web, Section 1.8

[Joshua D. Guttman]

[-- Attachment #1: Type: text/plain, Size: 655 bytes --]

Strange that no one seems to be correcting errors in the
manual any more.  I submitted a bug report for an error in
the automatically generated text in the manual (it fails
because dynlink was not loaded).  

I got a prompt response, for which I am grateful.  

Oddly, though, the response simply classifies this bug as a
duplicate of a bug reported in August 2010.  That bug is
marked as having its resolution open.

I suspect that the documentation could be fixed with a few
minutes work, followed by whatever process updates the
public version.  

It's not a big bug, but it's odd that no one has bothered to
fix it in eleven months.

        Joshua 


[-- Attachment #2: Type: message/rfc822, Size: 5641 bytes --]

From: Mantis Bug Tracker <nouser@inria.fr>
To: guttman@WPI.EDU
Subject: [OCaml 0005317]: Errors in OCaml manual on web, Section 1.8
Date: Thu, 21 Jul 2011 09:28:20 +0200
Message-ID: <0cf275fef7ea7bcc0e3b27dadc7cff82@caml.inria.fr>


The following issue has been set as DUPLICATE OF issue 0005132. 
====================================================================== 
http://caml.inria.fr/mantis/view.php?id=5317 
====================================================================== 
Reported By:                guttman
Assigned To:                
====================================================================== 
Project:                    OCaml
Issue ID:                   5317
Category:                   OCaml documentation
Reproducibility:            N/A
Severity:                   minor
Priority:                   normal
Status:                     new
====================================================================== 
Date Submitted:             2011-07-20 17:41 CEST
Last Modified:              2011-07-21 09:28 CEST
====================================================================== 
Summary:                    Errors in OCaml manual on web, Section 1.8
Description: 
At URL http://caml.inria.fr/pub/docs/manual-ocaml/manual003.html
as of today, there are errors reported in the code being illustrated. 

The first error is 

##load "camlp4o.cma";;
Characters -1–1:
Error: Reference to undefined global ‘Dynlink’
 
after which there are of course others, such as 

Error: Syntax error
 
#let parse_expression = parser [< e = parse_expr; _ = Stream.empty >] ->
e;;
Error: Syntax error
Composing the lexer and parser, we finally obtain a function to read an
expression from a character string:

#let read_expression s = parse_expression(lexer(Stream.of_string s));;
Error: Unbound value parse_expression


======================================================================
Relationships       ID      Summary
----------------------------------------------------------------------
duplicate of        0005132 machine-generated errors in the manual!
====================================================================== 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2011-07-20 17:41 guttman        New Issue                                    
2011-07-21 09:28 xclerc         Relationship added       duplicate of 0005132
======================================================================

[-- Attachment #3: Type: text/plain, Size: 49 bytes --]



-- 
	Joshua D. Guttman
	WPI, Computer Science 

RE: [Caml-list] [Mantis Bug Tracker] [OCaml 0005317]: Errors in OCaml manual on web, Section 1.8

[David Allsopp]

Joshua D. Guttman wrote:
> Strange that no one seems to be correcting errors in the manual any more.

Sweeping statements are often dangerous - if you look in the repository, you'll see that Damien fixed this issue two months ago as part of PR #5261. If you look in PR #5149 (where a whole load of other documentation bugs were addressed), you'll see a note stating that it has been fixed (it was point 1 there) - the only issue is that Mantis hasn't been fully updated and the docs haven't been recompiled since 3.12.0 (that's normal, though, I think - I was certainly under the impression that the manual is recompiled for minor version changes only, not revisions).


David

Re: [Caml-list] [Mantis Bug Tracker] [OCaml 0005317]: Errors in OCaml manual on web, Section 1.8

[Joshua D. Guttman]

David Allsopp <dra-news@metastack.com> writes:

>   if you look in the repository, you'll see that Damien
>   fixed this issue two months ago

... but ... 

>   the docs haven't been recompiled since 3.12.0  

So, you mean that somewhere there's a version which -- if
recompiled and posted to the web site -- would eliminate
this error?

That's good.  

However, there's this public repository of information,
which, if you happened to read it any time in the last 11
months, would have an already reported, cheap-to-fix error.

That seems a discordant note relative to the high quality of
the work as a whole, and the highly devoted people who
maintain it.  

        Joshua 
-- 
	Joshua D. Guttman
	WPI, Computer Science