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

xen: documentation and build fixes #331867

Merged
merged 3 commits into from
Aug 8, 2024
Merged

Conversation

SigmaSquadron
Copy link
Contributor

@SigmaSquadron SigmaSquadron commented Aug 2, 2024

Description of changes

  • Fixes typos and inaccuracies in the comments and README that escaped reviews in xen: 4.15 -> {4.16,4.17,4.18,4.19} #324693.
  • Adds ImageMagick to the build dependencies, in order to build the full HTML docs in the $doc output, thus fixing the Hydra build.
  • Fixes the meta.longDescription logic so it no longer tells people to use qemu_xen for a Xen that was built with the internal QEMU.

Things done

  • Built on platform(s)
    • x86_64-linux
  • Tested, as applicable:
    • pkg-config test passes successfully.
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD".
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@SigmaSquadron

This comment was marked as outdated.

@ofborg ofborg bot added 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 11-100 labels Aug 3, 2024
@SigmaSquadron SigmaSquadron force-pushed the xen-post-merge branch 2 times, most recently from f0c8857 to 558983d Compare August 4, 2024 14:48
@SigmaSquadron
Copy link
Contributor Author

Looks like some meta attributes were broken too.

@SigmaSquadron SigmaSquadron force-pushed the xen-post-merge branch 3 times, most recently from 549c54e to 5109ab2 Compare August 5, 2024 18:17
@SigmaSquadron
Copy link
Contributor Author

SigmaSquadron commented Aug 5, 2024

Split the PR into three commits for ease of review. Let me know if they need to be squashed.

@SigmaSquadron
Copy link
Contributor Author

SigmaSquadron commented Aug 8, 2024

According to the staging-next 4.19 build (which wasn't complete when this PR was posted), the fig2dev issue stems from the fact {Image,Graphics}Magick wasn't in the buildInputs.

/nix/store/cjy42fdjf6flll933b4vz27sximn6fa7-fig2dev-3.2.9/bin/fig2dev -L png network-bridge.fig >network-bridge.png.tmp
/nix/store/cjy42fdjf6flll933b4vz27sximn6fa7-fig2dev-3.2.9/bin/fig2dev -L png network-basic.fig >network-basic.png.tmp
sh: convert: not found
sh: gm: not found
make[2]: *** [Makefile:11: network-basic.png] Error 141
make[2]: *** Waiting for unfinished jobs....

Again, I have no idea how to reproduce this, but I have a feeling that just adding GraphicsMagick will do the trick.

@SigmaSquadron
Copy link
Contributor Author

Well, it doesn't fail when I add ImageMagick, and it does build the HTML documentation, which it didn't before. I see this as a good sign!

Minor changes to comments, examples and the README.

Signed-off-by: Fernando Rodrigues <[email protected]>
Xen not only has manual pages, but also a full documentation written
in HTML files. By adding ImageMagick, the `fig2dev` build doesn't
fail, so we can have the docs build in the $doc output.

This also fixes the Hydra build, but who cares about that? We have
good Xen docs now!

Signed-off-by: Fernando Rodrigues <[email protected]>
The description was mangled in search.nixos.org. It recommended using
qemu_xen with a Xen that already included QEMU, and there were edge
cases where there wouldn't be enough newlines to properly display the
full description.

Signed-off-by: Fernando Rodrigues <[email protected]>
@SigmaSquadron
Copy link
Contributor Author

Result of nixpkgs-review pr 331867 run on x86_64-linux 1

2 packages marked as broken and skipped:
  • libvmi
  • qubes-core-vchan-xen
53 packages built:
  • qemu_xen (qemu_xen_4_19)
  • qemu_xen.debug (qemu_xen_4_19.debug)
  • qemu_xen.ga (qemu_xen_4_19.ga)
  • qemu_xen_4_16
  • qemu_xen_4_16.debug
  • qemu_xen_4_16.ga
  • qemu_xen_4_17
  • qemu_xen_4_17.debug
  • qemu_xen_4_17.ga
  • qemu_xen_4_18
  • qemu_xen_4_18.debug
  • qemu_xen_4_18.ga
  • xen
  • xen-guest-agent
  • xen-slim
  • xen-slim.boot
  • xen-slim.dev
  • xen-slim.doc
  • xen-slim.man
  • xen.boot
  • xen.dev
  • xen.doc
  • xen.man
  • xenPackages.xen_4_16
  • xenPackages.xen_4_16-slim
  • xenPackages.xen_4_16-slim.boot
  • xenPackages.xen_4_16-slim.dev
  • xenPackages.xen_4_16-slim.doc
  • xenPackages.xen_4_16-slim.man
  • xenPackages.xen_4_16.boot
  • xenPackages.xen_4_16.dev
  • xenPackages.xen_4_16.doc
  • xenPackages.xen_4_16.man
  • xenPackages.xen_4_17
  • xenPackages.xen_4_17-slim
  • xenPackages.xen_4_17-slim.boot
  • xenPackages.xen_4_17-slim.dev
  • xenPackages.xen_4_17-slim.doc
  • xenPackages.xen_4_17-slim.man
  • xenPackages.xen_4_17.boot
  • xenPackages.xen_4_17.dev
  • xenPackages.xen_4_17.doc
  • xenPackages.xen_4_17.man
  • xenPackages.xen_4_18
  • xenPackages.xen_4_18-slim
  • xenPackages.xen_4_18-slim.boot
  • xenPackages.xen_4_18-slim.dev
  • xenPackages.xen_4_18-slim.doc
  • xenPackages.xen_4_18-slim.man
  • xenPackages.xen_4_18.boot
  • xenPackages.xen_4_18.dev
  • xenPackages.xen_4_18.doc
  • xenPackages.xen_4_18.man

Copy link
Contributor

@Mindavi Mindavi left a comment

Choose a reason for hiding this comment

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

Diff LGTM

@Mindavi Mindavi merged commit e72e9ae into NixOS:master Aug 8, 2024
29 of 31 checks passed
@SigmaSquadron SigmaSquadron deleted the xen-post-merge branch August 8, 2024 19:59
@SigmaSquadron
Copy link
Contributor Author

@Mindavi
Copy link
Contributor

Mindavi commented Aug 9, 2024

I'll build it on my machine too to see if i can reproduce.

I cannot reproduce this issue.

@SigmaSquadron
Copy link
Contributor Author

SigmaSquadron commented Aug 9, 2024

People who originally built PR #324693 couldn't reproduce this either, and OfBorg compiled it successfully. I have no idea why the problem is in Hydra.

I know there shouldn't be anything different between Hydra and a simple nix build, but over the arvo I've tried running my own Hydra instance on my machines, and all builds passed.

The error is 141, a SIGPIPE. The problematic code is in the Figs Makefile:

%.png:  %.fig
        $(FIG2DEV) -L png $< >[email protected]
        mv -f [email protected] $@

When running fig2dev, this is the final command:

fig2dev -L png network-bridge.fig >network-bridge.png.tmp
mv -f network-bridge.png.tmp network-bridge.png

If it's relevant, on the following Hydra builders, the build succeeded:

  • t4b.cunat.cz
  • 25a0f091.packethost.net

On this last run, the build only failed on the following builder:

  • 531e49c0.packethost.net

@Mindavi
Copy link
Contributor

Mindavi commented Aug 9, 2024

Yeah, ran the command by hand too without issues. Maybe an abort somewhere in ImageMagick.

@SigmaSquadron
Copy link
Contributor Author

Second time's the charm. #333764

@SigmaSquadron SigmaSquadron added the 6.topic: xen-project The Xen Project hypervisor label Sep 25, 2024
@SigmaSquadron SigmaSquadron mentioned this pull request Jan 12, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: xen-project The Xen Project hypervisor 10.rebuild-darwin: 1-10 10.rebuild-linux: 11-100 11.by: package-maintainer This PR was created by the maintainer of the package it changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants