0005690: "ocamldoc ... -text README" raises exception

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

Project

Category

View Status

Date Submitted

Last Update

0005690

OCaml

OCamldoc

public

2012-07-17 05:36

2012-08-16 11:49

Reporter

rmikhov

Assigned To

guesdon

Priority

low

Severity

trivial

Reproducibility

always

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

3.12.1

Target Version

Fixed in Version

4.00.1+dev

Summary

0005690: "ocamldoc ... -text README" raises exception

Description

Ocamldoc has the useful feature to be able to include a text file in the generated documentation, but unfortunately this text file must have an extension.

"ocamldoc ... -text README" raises Invalid_argument("Filename.chop_extension"). The problem is that coding standards often require to name your file README so you have to rename it, run ocamldoc, and rename it back... Also, it would be nice if it didn't show up in the list of modules.

Sorry to bother you.

Tags

No tags attached.

Attached Files

Relationships

Notes
(0007946) guesdon (manager) 2012-08-16 11:47	Handling -text files with no extension is now possible (Revision 12862 in version/4.00 and revision 12863 in trunk). They will still appear in the module list, though, to benefit from cross referencing possibilities.

Issue History
Date Modified	Username	Field	Change
2012-07-17 05:36	rmikhov	New Issue
2012-07-17 05:36	rmikhov	Status	new => assigned
2012-07-17 05:36	rmikhov	Assigned To	=> guesdon
2012-08-16 11:47	guesdon	Note Added: 0007946
2012-08-16 11:49	guesdon	Status	assigned => closed
2012-08-16 11:49	guesdon	Resolution	open => fixed
2012-08-16 11:49	guesdon	Fixed in Version	=> 4.00.1+dev