voodoos / ocaml-index

MIT License
4 stars 0 forks source link

[Doc] Add installation instructions #2

Open sidkshatriya opened 1 year ago

sidkshatriya commented 1 year ago

Can we have a short series of instructions for those people who may want to try this out locally? I understand that getting this to work requires a custom version of dune, merlin/ocaml-lsp-server in addition to this repo.

Which repos do I need to clone and pin locally and so on.

This will be extremely useful. Searching across project is a very useful feature and I want to try it out, even if this feature is not fully ready!

voodoos commented 1 year ago

Providing a first basic testable version is my focus right now, should arrive soon :-)

ELLIOTTCABLE commented 1 year ago

Exciting! We managed to get pretty far just by spelunking, but finally ran into some issues (#3). Looking forward to it!

voodoos commented 1 year ago

I just pushed a new repo with scripts and installation / usage instructions. It is still heavily wip, but should work on simple to intermediately complex projects.

https://github.com/voodoos/merlin-occurrences-switch

sidkshatriya commented 1 year ago

Thanks for being prompt about this!

I notice that a customized OCaml version (4.14 + modifications IIUC) is being built in the merlin-occurences-switch switch.

I thought shapes were fully integrated into the ocaml compiler codebase. So why do we have a custom codebase OCaml being used in the switch?

voodoos commented 1 year ago

I thought shapes were fully integrated into the ocaml compiler codebase. So why do with have a custom codebase OCaml being used in the switch?

Because shapes were added with the jump-to-definition feature in mind and some hard to anticipate details necessary for occurrences were overlooked. The patches are small and will hopefully be part of the next patch releases of the compiler.