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

qemu: allow to disable generation of documentation #227477

Merged
merged 2 commits into from Apr 22, 2023
Merged

qemu: allow to disable generation of documentation #227477

merged 2 commits into from Apr 22, 2023

Conversation

ghost
Copy link

@ghost ghost commented Apr 21, 2023

Description of changes

I've been having trouble with some qemu builds since the v8.0.0 bump failing with:

kernel-doc 'perl /build/qemu/docs/../scripts/kernel-doc -rst -enable-lineno -sphinx-version 5.3.0 -Werror /build/qemu/docs/../include/qemu/bitops.h' processing failed with: [Errno 2] No such file or directory: 'perl'

... this happens despite perl being part of stdenv. Adding perl to nativeBuildInputs doesn't seem to fix it. It is handy to be able to simply skip the docs in situations like this in order to maintain forward progress, so this commit adds enableDocs?true to allow that.

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
  • Fits CONTRIBUTING.md.

Adam Joseph and others added 2 commits April 22, 2023 00:24
I've been having trouble with some qemu builds since the v8.0.0 bump
failing with:

```
kernel-doc 'perl /build/qemu/docs/../scripts/kernel-doc -rst -enable-lineno -sphinx-version 5.3.0 -Werror /build/qemu/docs/../include/qemu/bitops.h' processing failed with: [Errno 2] No such file or directory: 'perl'
```

... this happens despite `perl` being part of `stdenv`.  Adding
`perl` to `nativeBuildInputs` doesn't seem to fix it.  It is handy
to be able to simply skip the docs in situations like this in order
to maintain forward progress, so this commit adds `enableDocs?true`
to allow that.
Copy link
Member

@Artturin Artturin left a comment

Choose a reason for hiding this comment

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

reduces the size of qemu-user from 45M -> 31M

@Artturin Artturin merged commit b0a5a68 into NixOS:master Apr 22, 2023
@ghost ghost deleted the pr/qemu/enableDocs branch April 24, 2023 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant