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

doc(pkg): Explain package management #10950

Merged

Conversation

Leonidas-from-XIV
Copy link
Collaborator

The explanation part of dune package management, split out following the feedback of #10920, aimed at users who want to have a deeper understanding on how the system works under the hood.

@Leonidas-from-XIV Leonidas-from-XIV added docs Documentation improvements package management labels Sep 23, 2024
@Leonidas-from-XIV Leonidas-from-XIV marked this pull request as ready for review September 24, 2024 09:48
packages to install from the `depends` stanza in the `dune-project` file. This
allows projects to completely omit generation of `.opam` files, as long as they
use Dune for package management. Thus all dependencies are only declared in one
file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick remark: if you are not generating .opam files anymore, then your package is no longer pinnable by opam. There's an issue to fix this in the opam tracker (ie. allow on-the-fly generating of opam files).

@samoht
Copy link
Member

samoht commented Sep 24, 2024

I've made a quick read and left a few comments - I'm also wondering if we should highlight the Dune cache a bit more here - that's one of the killer features of dune pkg: instant build of most of your dependencies (including the compiler) as they could be re-used between projects.

doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Show resolved Hide resolved
doc/explanation/package-management.md Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@christinerose christinerose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions for potentially clarifying sentences.

doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
doc/explanation/package-management.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ElectreAAS ElectreAAS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this!

@maiste maiste self-requested a review October 3, 2024 16:18
Copy link
Collaborator

@gridbugs gridbugs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice explanation! I've left some minor suggestions here and there.

Signed-off-by: Marek Kubica <marek@tarides.com>
@Leonidas-from-XIV Leonidas-from-XIV merged commit fe9482a into ocaml:main Oct 4, 2024
26 of 27 checks passed
@Leonidas-from-XIV Leonidas-from-XIV deleted the dune-pkg-explanation branch October 4, 2024 13:17
anmonteiro pushed a commit to anmonteiro/dune that referenced this pull request Nov 17, 2024
Signed-off-by: Marek Kubica <marek@tarides.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements package management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants