From 9b4df11473049e2fed2f0225d5c8133886b5f795 Mon Sep 17 00:00:00 2001 From: Rangi Date: Thu, 2 Jul 2026 12:36:31 -0400 Subject: [PATCH] Describe how to patch external projects --- docs/CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 70e5739c..bd982aa7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -225,16 +225,21 @@ Each one is a binary RNG file which is passed to the `rgbgfx_test` program. ### External projects -Each `*.cfg` file corresponds to one test. +Each `.cfg` file corresponds to one test. Each one defines the parameters for a real external project that builds using RGBDS. 1. Make sure the downstream project supports - make <target> RGBDS=<path/to/RGBDS/>. + make <target> RGBDS=<path/to/rgbds/>. While the test suite supports any Make target name, only [Make](//gnu.org/software/make) is currently supported, and the Makefile must support a `RGBDS` variable to use a non-system RGBDS directory. 2. Create the new `.cfg` file, following the existing ones. +If an external project does not support `make RGBDS=`, or otherwise fails to +build with current RGBDS, then then you can edit the project to build correctly, +and create a patch with `git diff` to be committed as +test/external/patches/<project>.patch. + ## Container images The CI will