Skip to content

doc: add CUDA contributing section#414612

Merged
fricklerhandwerk merged 2 commits intoNixOS:masterfrom
ConnorBaker:feat/cuda-doc-passthru-testing
Jul 14, 2025
Merged

doc: add CUDA contributing section#414612
fricklerhandwerk merged 2 commits intoNixOS:masterfrom
ConnorBaker:feat/cuda-doc-passthru-testing

Conversation

@ConnorBaker
Copy link
Contributor

@ConnorBaker ConnorBaker commented Jun 6, 2025 •
edited
Loading

This PR:

  • introduces a Contributing section
  • updates all IDs in the document so they share a cuda- prefix and updates doc/redirects.json with redirects
  • moves package set maintenance related topics (like updates) to a new section inside Contributing
  • adds sections to Contributing about writing testers and tests
  • adds tests to magma

NOTE: The tests build but do not currently run on Jetson devices due to unrelated issues (RUNPATH, mostly).

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.

@ConnorBaker ConnorBaker self-assigned this Jun 6, 2025
@ConnorBaker ConnorBaker added 8.has: documentation This PR adds or changes documentation 6.topic: testing Tooling for automated testing of packages and modules 6.topic: best practices Documentation and discussion around best practices for Nixpkgs development 6.topic: cuda Parallel computing platform and API labels Jun 6, 2025
@github-actions github-actions bot removed 6.topic: testing Tooling for automated testing of packages and modules 6.topic: cuda Parallel computing platform and API labels Jun 6, 2025
@ConnorBaker ConnorBaker moved this from New to 🏗 In progress in CUDA Team Jun 6, 2025
@github-actions github-actions bot added 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. labels Jun 6, 2025
@ConnorBaker ConnorBaker force-pushed the feat/cuda-doc-passthru-testing branch from 8160a92 to e1661f3 Compare June 9, 2025 15:30
@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jun 9, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 414612

x86_64-linux

✅ 1 package built:
  • nixpkgs-manual

1 similar comment
@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jun 9, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 414612

x86_64-linux

✅ 1 package built:
  • nixpkgs-manual

@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jun 9, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 414612
Commit: e1661f38d72f92c2d4502b1ea34fae3cc4f6a7a1

x86_64-darwin

✅ 1 package built:
  • nixpkgs-manual

aarch64-darwin

✅ 1 package built:
  • nixpkgs-manual

@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jun 9, 2025

On a NixOS system with ~/.config/nixpkgs/config.nix

{
  allowAliases = false;
  allowBroken = false;
  allowUnfree = true;
  checkMeta = true;
  contentAddressedByDefault = false;
  cudaCapabilities = [ "8.9" ];
  cudaSupport = true;
}

I was able to run

nix build --impure -L .#magma-cuda-static.passthru.tests.all

successfully.

On a non-NixOS system with the same ~/.config/nixpkgs/config.nix, I was able to run

nixglhost -- nix run --impure -L .#magma-cuda-static.passthru.testers.all

successfully.

@ConnorBaker ConnorBaker marked this pull request as ready for review June 9, 2025 16:50
@ConnorBaker ConnorBaker added the 6.topic: cuda Parallel computing platform and API label Jun 9, 2025
@ConnorBaker ConnorBaker requested a review from SomeoneSerge June 9, 2025 16:51
fricklerhandwerk
fricklerhandwerk reviewed Jun 9, 2025
View reviewed changes
fricklerhandwerk
fricklerhandwerk approved these changes Jun 9, 2025
View reviewed changes
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

lgtm docs wise

@wegank wegank 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 Jun 9, 2025
@github-actions github-actions bot removed the 6.topic: cuda Parallel computing platform and API label Jun 9, 2025
@ConnorBaker ConnorBaker force-pushed the feat/cuda-doc-passthru-testing branch from 807a31e to ca9475a Compare June 9, 2025 19:47
@ConnorBaker ConnorBaker mentioned this pull request Jun 9, 2025
Merged
13 tasks
@ConnorBaker ConnorBaker moved this from 🏗 In progress to 👀 Awaits reviews in CUDA Team Jun 9, 2025
SomeoneSerge
SomeoneSerge reviewed Jun 10, 2025
View reviewed changes
@ConnorBaker ConnorBaker moved this from 👀 Awaits reviews to 🏗 In progress in CUDA Team Jun 11, 2025
@nixpkgs-ci nixpkgs-ci bot removed the 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in any of the changed packages. label Jun 25, 2025
@ConnorBaker ConnorBaker force-pushed the feat/cuda-doc-passthru-testing branch from ca9475a to d6090b1 Compare July 10, 2025 21:00
@ConnorBaker ConnorBaker changed the title doc: writing tests for CUDA-enabled packages doc: add CUDA contributing section Jul 10, 2025
@ConnorBaker ConnorBaker requested a review from SomeoneSerge July 10, 2025 21:14
@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jul 10, 2025

@SomeoneSerge I added the Contributing section per our conversation and did some general cleanup.

@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jul 10, 2025

CC @djacu

@ConnorBaker ConnorBaker mentioned this pull request Jul 10, 2025
Merged
13 tasks
djacu
djacu suggested changes Jul 11, 2025
View reviewed changes
Copy link
Member

@djacu djacu left a comment

Choose a reason for hiding this comment

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

Solid work

I am only reviewing the updates to the documentation.

doc/languages-frameworks/cuda.section.md Outdated
Copy link
Member

@djacu djacu Jul 11, 2025

Choose a reason for hiding this comment

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

Any more details for "and so on" or is it common enough knowledge amonst CUDA contributors?

@github-project-automation github-project-automation bot moved this from 🏗 In progress to 📋 The forgotten in CUDA Team Jul 11, 2025
@ConnorBaker ConnorBaker force-pushed the feat/cuda-doc-passthru-testing branch from d6090b1 to be7e126 Compare July 12, 2025 02:01
@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jul 12, 2025

Fantastic suggestions! Thank you, @djacu!

@nixpkgs-ci nixpkgs-ci bot added 12.approvals: 2 This PR was reviewed and approved by two persons. and removed 12.approvals: 1 This PR was reviewed and approved by one person. labels Jul 12, 2025
@fricklerhandwerk fricklerhandwerk merged commit 07e8255 into NixOS:master Jul 14, 2025
25 of 28 checks passed
@github-project-automation github-project-automation bot moved this from 📋 The forgotten to ✅ Done in CUDA Team Jul 14, 2025
@nixpkgs-ci
Copy link
Contributor

nixpkgs-ci bot commented Jul 14, 2025

Backport failed for release-25.05, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-25.05
git worktree add -d .worktree/backport-414612-to-release-25.05 origin/release-25.05
cd .worktree/backport-414612-to-release-25.05
git switch --create backport-414612-to-release-25.05
git cherry-pick -x 91e91bc5963bb23f3f1e17916deb3495701f52b8 be7e126e474c29cefe66070743d001404b257fe0

@ConnorBaker ConnorBaker mentioned this pull request Jul 14, 2025
Merged
@ConnorBaker
Copy link
Contributor Author

ConnorBaker commented Jul 14, 2025

Backport is in #425172.

@ConnorBaker ConnorBaker deleted the feat/cuda-doc-passthru-testing branch July 14, 2025 20:05
@mdaniels5757 mdaniels5757 added 8.has: port to stable This PR already has a backport to the stable release. and removed backport release-25.05 labels Jul 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fricklerhandwerk fricklerhandwerk fricklerhandwerk approved these changes

@hsjobeki hsjobeki Awaiting requested review from hsjobeki

@GetPsyched GetPsyched Awaiting requested review from GetPsyched

@SomeoneSerge SomeoneSerge Awaiting requested review from SomeoneSerge

+1 more reviewer

@djacu djacu djacu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ConnorBaker ConnorBaker

Labels

6.topic: best practices Documentation and discussion around best practices for Nixpkgs development 8.has: documentation This PR adds or changes documentation 8.has: port to stable This PR already has a backport to the stable release. 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. 12.approvals: 2 This PR was reviewed and approved by two persons.

Projects

CUDA Team
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ConnorBaker @fricklerhandwerk @djacu @SomeoneSerge @mdaniels5757 @wegank