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

the manual page of ocamldoc does not mention -charset option #7632

Closed
vicuna opened this Issue Sep 19, 2017 · 3 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link
Collaborator

vicuna commented Sep 19, 2017

Original bug ID: 7632
Reporter: kosik
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2017-09-30T12:37:21Z)
Resolution: fixed
Priority: normal
Severity: trivial
Version: 4.05.0
Fixed in version: 4.06.0 +dev/beta1/beta2/rc1
Category: ocamldoc

Bug description

ocamldoc supports -charset option.

This is mentioned in

ocamldoc -help

as well as, e.g., here:

http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html

However, it is not mentioned in ocamldoc manual page.

I guess that it probably makes sense to mention it also there.

Steps to reproduce

man ocamldoc | grep charset

@vicuna

This comment has been minimized.

Copy link
Collaborator Author

vicuna commented Sep 19, 2017

Comment author: @gasche

Indeed. I found other ocamldoc-specific options missing from the manpage:

-no-module-constraint-filter
-show-missed-crossref
-text

Matej, would you be willing to submit a pull request to document those, just reusing the -help documentation? The manpage is in man/ocamldoc.m from the root of the OCaml directory:

https://github.com/ocaml/ocaml/blob/trunk/man/ocamldoc.m

@vicuna

This comment has been minimized.

Copy link
Collaborator Author

vicuna commented Sep 19, 2017

Comment author: kosik

OK #1356

@vicuna

This comment has been minimized.

Copy link
Collaborator Author

vicuna commented Sep 30, 2017

Comment author: @Octachron

Fixed by merging the PR above in 4.06, thanks for the patch!

@vicuna vicuna closed this Sep 30, 2017

@vicuna vicuna added the ocamldoc label Mar 14, 2019

@vicuna vicuna added the bug label Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.