Skip to content

apple-sdk: Include man pages starting from version 15#408480

Open
zhaofengli wants to merge 2 commits intoNixOS:stagingfrom
zhaofengli:apple-sdk-man
Open

apple-sdk: Include man pages starting from version 15#408480
zhaofengli wants to merge 2 commits intoNixOS:stagingfrom
zhaofengli:apple-sdk-man

Conversation

@zhaofengli
Copy link
Copy Markdown
Member

Apple SDKs include man pages for command-line utilities shipped with macOS as well as APIs, many of which are not available in source releases. It would be nice to have them in apple-sdk.

Since those man pages may conflict with those provided by Nixpkgs, we split them into a separate output named sdkman to avoid polluting devShells by default. In order to minimize rebuilds, the change is also gated to SDKs starting from version 15.

The man pages themselves appear to be compressible:

$ nix-store --dump /nix/store/26940l0019wnn7sg41x7zcz5ywimaxl3-apple-sdk-15.2-sdkman > apple-sdk-15.2-sdkman.nar
$ zstd apple-sdk-15.2-sdkman.nar -o apple-sdk-15.2-sdkman.nar.zst
apple-sdk-15.2-sdkman.nar : 58.24%   (  46.6 MiB =>   27.1 MiB, apple-sdk-15.2-sdkman.nar.zst)

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/)
  • Nixpkgs 25.11 Release Notes (or backporting 24.11 and 25.05 Nixpkgs Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
  • NixOS 25.11 Release Notes (or backporting 24.11 and 25.05 NixOS Release notes)
    • (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.

Add a 👍 reaction to pull requests you find important.

Comment thread pkgs/by-name/ap/apple-sdk/common/split-man-pages-output.nix Outdated
@github-actions github-actions Bot added 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels May 18, 2025
Comment thread pkgs/by-name/ap/apple-sdk/common/split-man-pages-output.nix Outdated
@zhaofengli zhaofengli force-pushed the apple-sdk-man branch 3 times, most recently from 4c874ef to f3105fd Compare May 18, 2025 21:32
@zhaofengli zhaofengli changed the base branch from master to staging May 18, 2025 21:32
We only include the man pages beginning with SDK version 15 to
minimize hash changes.
@zhaofengli
Copy link
Copy Markdown
Member Author

With #409574 merged, I reworked the PR to return to determining whether the fetched SDK has man pages with src.passthru.includeMan. This feels cleaner to me - fetch-sdk is responsible for pruning the raw SDK and can potentially be overridden, and it should therefore be the source of truth of whether the man pages are actually included.

@nixpkgs-ci nixpkgs-ci Bot added the 2.status: merge conflict This PR has merge conflicts with the target branch label Sep 17, 2025
@nixpkgs-ci nixpkgs-ci Bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Nov 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.status: merge conflict This PR has merge conflicts with the target branch 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 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: 0 This PR does not cause any packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants