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
Re: ocaml: Bug in Pervasives man page #3686
Comments
Comment author: administrator On Thu, Jun 16, 2005 at 02:59:58 +0200, Julien Cristau wrote:
I think there is another problem with odoc_man. When a comment contains As a dot as the first character of a line is a special character, part3 This becomes in ocamldoc/stdlib_man/Lexing.3o: The words "The function should put" don't appear in the manpage. Thanks, -----BEGIN PGP SIGNATURE----- iD8DBQFCvsRUmEvTgKxfcAwRArp3AKC+inPkFyeOErsiVRAtjZkbvhpuDQCggbMD |
Comment author: administrator Hello, Thanks for pointing the two problems:
Thanks for the report. Regards, -- |
Comment author: administrator On Thu, Jun 30, 2005 at 11:38:47 +0200, Maxence Guesdon wrote:
thanks!
Ideally, I think things like these could be: This gives the correct behaviour, but I guess it wouldn't be easy to Since there shouldn't be a dot as first character of a line in an Cheers, |
Comment author: administrator Hello,
groff info pages say (gtroff reference -> embedded commands -> requests): " To begin a line with a control character without it being Hence the standard solution is: Regards, Emmanuel |
Comment author: administrator
Hello, ah ok, thank you very much, it works well ! Regards, -- |
Original bug ID: 3686
Reporter: administrator
Status: closed
Resolution: fixed
Priority: normal
Severity: minor
Category: ~DO NOT USE (was: OCaml general)
Bug description
forwarded 301046 caml-bugs@inria.fr
tags 301046 patch upstream
thanks
On Wed, Mar 23, 2005 at 06:19:05 +0100, Samuel Mimram wrote:
I think this is a bug in ocamldoc, which doesn't escape strings when
generating a manpage. From ocamldoc/odoc_man.ml:
(** Escape special sequences of characters in a string. *)
method escape (s : string) = s
groff interprets sequences beginning with a backslash, so real
backslashes need to be escaped. (There might be other substitutions
needed, but I don't know enough groff to do a complete fix)
With the following patch, the ocamldoc-generated Pervasives manpage
doesn't have any groff warnings (backslashes are escaped using the (rs
sequence).
Index: ocamldoc/odoc_man.ml
RCS file: /caml/ocaml/ocamldoc/odoc_man.ml,v
retrieving revision 1.24
diff -u -b -B -r1.24 odoc_man.ml
--- ocamldoc/odoc_man.ml 24 Mar 2005 17:20:53 -0000 1.24
+++ ocamldoc/odoc_man.ml 16 Jun 2005 00:54:43 -0000
@@ -188,6 +188,7 @@
(** This class is used to create objects which can generate a simple html documentation. *)
class man =
let re_slash = Str.regexp_string "/" in
object (self)
inherit info
@@ -197,7 +198,7 @@
Str.global_replace re_slash "slash" s
method escape (s : string) = Str.global_replace re_backslash "\(rs" s
(** Open a file for output. Add the target directory.*)
method open_out file =
Regards,
Julien Cristau
The text was updated successfully, but these errors were encountered: