Skip to content

ghc: patch build of docs after sphinx update#263923

Merged
vcunat merged 1 commit intoNixOS:staging-nextfrom
vcunat:p/ghc-docs
Oct 28, 2023
Merged

ghc: patch build of docs after sphinx update#263923
vcunat merged 1 commit intoNixOS:staging-nextfrom
vcunat:p/ghc-docs

Conversation

@vcunat
Copy link
Copy Markdown
Member

@vcunat vcunat commented Oct 28, 2023

Upstream: https://gitlab.haskell.org/ghc/ghc/-/issues/24129

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • 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.11 Release Notes (or backporting 23.05 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
  • Fits CONTRIBUTING.md.

@github-actions github-actions bot added the 6.topic: haskell General-purpose, statically typed, purely functional programming language label Oct 28, 2023
@vcunat
Copy link
Copy Markdown
Member Author

vcunat commented Oct 28, 2023 •
edited
Loading

I think this would be a recommended approach to fix this, but I don't know this stuff.

  • check that the docs look OK visually - perhaps by someone familiar with them?
  • apply/check to other GHC versions, too

@vcunat vcunat mentioned this pull request Oct 28, 2023
Merged
12 tasks
@vcunat
Copy link
Copy Markdown
Member Author

vcunat commented Oct 28, 2023

My expectation is that this should also work with (some?) previous versions of sphinx, but we most likely don't need to consider that in nixpkgs.

@mweinelt mweinelt marked this pull request as ready for review October 28, 2023 09:17
@mweinelt
Copy link
Copy Markdown
Member

mweinelt commented Oct 28, 2023

Marking as ready, so the codeowners will be requested and we can move this along.

@ofborg ofborg bot requested review from expipiplus1 and guibou October 28, 2023 09:44
@ofborg ofborg bot added 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. labels Oct 28, 2023
@mweinelt
Copy link
Copy Markdown
Member

mweinelt commented Oct 28, 2023

The users guide looks the same as before with this patch.

master

image

this pr

image

@vcunat
Copy link
Copy Markdown
Member Author

vcunat commented Oct 28, 2023

I'm looking into how it applies to other GHC versions.

sternenseemann
sternenseemann approved these changes Oct 28, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@sternenseemann sternenseemann left a comment

Choose a reason for hiding this comment

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

Seems like we replecate the old behavior this way: https://github.com/sphinx-doc/sphinx/pull/11381/files#diff-991c6e04000e3882ef75aeef0295198a89115779015d713e0d1535a48bf653f3

@delroth delroth added 12.approvals: 1 This PR was reviewed and approved by one person. 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in any of the changed packages. labels Oct 28, 2023
@vcunat
ghc*: patch build of docs after sphinx update
176ccbc 
The 8.x versions don't seem to need this (and the patch wouldn't apply).
@vcunat
Copy link
Copy Markdown
Member Author

vcunat commented Oct 28, 2023

I think I've covered everything now. 8.x seemed OK without touching them. For verification I built 9.0, 9.2, 9.4, 9.6, 9.8 and HEAD. (all on x86_64-linux)

@delroth delroth removed the 12.approvals: 1 This PR was reviewed and approved by one person. label Oct 28, 2023
@ofborg ofborg bot requested a review from sternenseemann October 28, 2023 13:13
@delroth delroth added the 12.approvals: 1 This PR was reviewed and approved by one person. label Oct 28, 2023
@vcunat vcunat merged commit 9116839 into NixOS:staging-next Oct 28, 2023
@vcunat vcunat deleted the p/ghc-docs branch October 30, 2023 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sternenseemann sternenseemann sternenseemann approved these changes

@cdepillabout cdepillabout Awaiting requested review from cdepillabout

@maralorn maralorn Awaiting requested review from maralorn

@guibou guibou Awaiting requested review from guibou

@expipiplus1 expipiplus1 Awaiting requested review from expipiplus1

Assignees

No one assigned

Labels

6.topic: haskell General-purpose, statically typed, purely functional programming language 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. 12.approvals: 1 This PR was reviewed and approved by one person. 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in any of the changed packages.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vcunat @mweinelt @sternenseemann @delroth