Skip to content

[OCaml/buildDunePackage] tell dune where to install doc and man#211748

Merged
vbgl merged 1 commit intoNixOS:masterfrom
bobot:patch-1
Mar 14, 2023
Merged

[OCaml/buildDunePackage] tell dune where to install doc and man#211748
vbgl merged 1 commit intoNixOS:masterfrom
bobot:patch-1

Conversation

@bobot
Copy link
Copy Markdown
Contributor

@bobot bobot commented Jan 20, 2023

Description of changes

buildDunePackage helper
fixupPhase move $out/doc to $out/share/doc (same for man). So the information of their location in the dune-project file is outdated which breaks dependencies on packages ( (package foo)).

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.05 Release Notes (or backporting 22.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

@ofborg ofborg bot added 10.rebuild-darwin: 11-100 This PR causes between 11 and 100 packages to rebuild on Darwin. 10.rebuild-linux: 101-500 This PR causes between 101 and 500 packages to rebuild on Linux. labels Jan 20, 2023
@bobot
Copy link
Copy Markdown
Contributor Author

bobot commented Feb 3, 2023

@vbgl do you have time to look at it? thanks

@vbgl vbgl added the 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. label Feb 3, 2023
Copy link
Copy Markdown
Contributor

@vbgl vbgl left a comment

Choose a reason for hiding this comment

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

This does not work with dune 1:

dune: unknown option --doc', did you mean --dev' ?
unknown option `--man'.

@vbgl
Copy link
Copy Markdown
Contributor

vbgl commented Mar 13, 2023

The doc/ directory has been addressed there: #220592.

`fixupPhase` move `$out/man` to `$out/share/man`. So the information of their location in the dune-project file is outdated which breaks dependencies on packages ( `(package foo)`).
@github-actions github-actions bot removed the 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. label Mar 14, 2023
@bobot
Copy link
Copy Markdown
Contributor Author

bobot commented Mar 14, 2023

@vbgl Thank you for the heads up. rebased and added in the conditional.

Copy link
Copy Markdown
Contributor

@vbgl vbgl left a comment

Choose a reason for hiding this comment

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

Thanks.

@vbgl vbgl merged commit 3b3e37f into NixOS:master Mar 14, 2023
@Janik-Haag Janik-Haag added the 12.first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

10.rebuild-darwin: 11-100 This PR causes between 11 and 100 packages to rebuild on Darwin. 10.rebuild-linux: 101-500 This PR causes between 101 and 500 packages to rebuild on Linux. 12.first-time contribution This PR is the author's first one; please be gentle!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants