Display package CHANGES file

[samoht]

Extracted from #466

Targeted for outgoing as it is not clear to me how this can be done properly.

[yami-no-ryuu]

+1 vote

[dbuenzli]

FWIW the packages that I packaged myself install README.md and CHANGES.md in doc.

opam info PKG could try to look for these files and display them if they are present. Maybe change the synopsis of info to something like (opam info [OPTION]... [KIND] [PATTERNS]... where KIND can be:

• pkg (default), current info output
• doc, ls the doc directory of the package (full paths)
• readme, look for a README.{txt,md,pdf,ps} file and display it in a viewer.
• changes , same as readme but with CHANGES
• api, open api docs in a viewer.

To avoid overloading opam this could also be provided via another tool like opam-doc (well that name is already taken). A tool that does that kind of thing quite well is texdoc for TeXLive, try texdoc texdoc for an explanation, however it does not really handle standard entry points like CHANGES well imho.

[dbuenzli]

To avoid overloading opam this could also be provided via another tool like opam-doc (well that name is already taken).

odig basically does this. It works only with text files but allows to access them in your terminal or in our browser.

[dbuenzli]

Here again following #1900 (comment) I think this can be closed.