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

Missing @dircategory and @direntry to info files #5464

Closed
vicuna opened this issue Jan 4, 2012 · 3 comments
Closed

Missing @dircategory and @direntry to info files #5464

vicuna opened this issue Jan 4, 2012 · 3 comments
Assignees

Comments

@vicuna
Copy link

vicuna commented Jan 4, 2012

Original bug ID: 5464
Reporter: mehdi
Assigned to: @lefessan
Status: closed (set by @xavierleroy on 2013-08-31T10:44:12Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 3.12.1
Fixed in version: 3.13.0+dev
Category: documentation
Monitored by: @lefessan @glondu

Bug description

There is one problem in the info file
usr/share/info/ocaml.info.gz
because it does not ship info dir sections. Thus, calling install-info (the GNU version) on these files issue a warning:
install-info: warning: no info dir entry in `/usr/share/info/...'
and the file is not included in the dir file.

The source of this problem is the following missing entry in the
texinfo source:
@dircategory Package short info
@direntry
* menu item 1: (infofile). Description.
* menu item 2: (infofile2). Description.
@EnD direntry

Additional information

Additional information can be found in:
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=528887
http://lintian.debian.org/tags/info-document-missing-dir-entry.html
http://lintian.debian.org/tags/info-document-missing-dir-section.html

@vicuna
Copy link
Author

vicuna commented Jan 5, 2012

Comment author: @lefessan

From what I understand, since OCaml Manual is generated by Hevea, the bug should be sent to Hevea's maintainers. In the meantime, the OCaml manual could be fixed by adding (manually, in the Makefile) something like this to ocaml.info (after the first line):

INFO-DIR-SECTION OCaml Programming Language
START-INFO-DIR-ENTRY

  • ocaml: (ocaml). OCaml Reference Manual
    END-INFO-DIR-ENTRY

@vicuna
Copy link
Author

vicuna commented Jan 6, 2012

Comment author: @lefessan

I submitted a fix in the ocamldoc SVN, commit r11993. If nobody complains about it, I will close this bug report.

@vicuna
Copy link
Author

vicuna commented Jan 9, 2012

Comment author: mehdi

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants