ocaml / ocaml/dune

Difficulty vendoring base and core

Open
#3,971 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

acknowledged vendoring
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

This is a continuation of an OCaml discuss thread and Merlin issue re: jumping to definition inside installed libraries, where people suggested vendoring base and core.

I'm having an issue with ppx_compare.runtime-lib. I've attached my dune project,1 including some READMEs indicating what I tried and how to follow the same steps I ran to reproduce the error.

Separately, if vendoring is the right route I should be going down for getting jumping to definition, I'd like to get a sense of how it plays with releasing to opam. If I want to release a project w/ vendored libs, do I need to do anything differently than I would have had the project been using installed libs? What about if I want to vendor a library that didn't come from opam -- how would I express that dependency and would I need to do something differently?

1: minimal-vendored-core.tar.gz

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the attached minimal-vendored-core.tar.gz and its dune project and READMEs, then review the linked OCaml Discuss thread and Merlin issue. Reproduce the ppx_compare.runtime-lib and installed-library navigation problem, and determine the required vendoring and opam release behavior, including dependencies not sourced from opam.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.