rules_ll follows the
+LLVM code of conduct.
Report violations to:
+ + +aaron@eomii.orgjannis@eomii.orgrules_ll uses code-quality tools for a consistent style across the repository.
Use the rules_ll development shell to get the various tools you need to work
+on the project:
nix develop .#dev
+The flake automatically sets up pre-commit in the shell which run on every local +commit. You can also run the hooks manually:
+nix flake check -L
+rules_ll uses mkdocs for the docs. To run a local development server:
mkdocs serve
+If you change documentation in the ll/ directory, regenerate the API reference
+docs:
./generate_docs.sh
+This populates the docs/reference/ directory with the updated markdown files.
The examples at rules_ll/examples also act as tests for the project. If you
+don't use devenv make sure to run the examples from the flake in the
+examples directory:
nix develop
+Heterogeneous tests fail on machines without the corresponding GPU, but they +should still produce executables:
+# Should pass on all machines.
+bazel test cpp
+
+# Should pass on machines with supported Nvidia GPUs.
+bazel test nvptx
+
+# Should pass on machines with supported AMD GPUs.
+bazel test amdgpu
+
+# Even if some of these tests fail, they should all build and run.
+bazel test all
+By default, GitHub's bots crawl rules_ll for security vulnerabilities wherever
+possible.
The rules_ll developers place a high emphasis on fixing any vulnerabilities,
+so please don't hesitate to send a report if something doesn't look right.
rules_ll always supports just the latest tag. Consider all older versions as
+unsupported and deprecated.
Please prefer reporting vulnerabilities via +GitHub.
+If you prefer communication via email please contact aaron@eomii.org and +jannis@eomii.org.
+See Advisories for +publicly disclosed vulnerabilities.
+ + + + + + + + + + + + + +