down icon indicating copy to clipboard operation
down copied to clipboard

Suggest using XDG convention to locate the ocaml init file

Open MisterDA opened this issue 11 months ago • 2 comments

The README suggests using ~/.ocamlinit, but since OCaml 4.10 the toplevel adheres to the XDG convention (thanks!). The README and the opam package description should reflect that. Opam files also have a post-message field which could be used to prompt the user to add the configuration to the init file.

MisterDA avatar Jan 15 '25 14:01 MisterDA

The post-install message could also advise to install ocp-index. This would prevent an error later raised:

Error: Completion and doc lookup needs ocp-index. Try 'opam install ocp-index'.

MisterDA avatar Jan 15 '25 14:01 MisterDA

The post-install message could also advise to install ocp-index. This would prevent an error later raised:

Error: Completion and doc lookup needs ocp-index. Try 'opam install ocp-index'.

Incidentally, if you are trying ocp-index I think https://github.com/OCamlPro/ocp-index/pull/170 will be useful (unfortunately, left unmerged by the maintainers).

nojb avatar Jan 15 '25 14:01 nojb