gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2026-08-21 22:34:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use git clean -fdx instead of make clean in external projects

Browse Source
This commit is contained in:
Rangi
2026-07-05 20:58:50 -04:00
committed by Rangi
parent 6e643406a2
commit f81f5fe63c
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CONTRIBUTING.md
+5 -6
View File
@@ -232,16 +232,15 @@ Each one is a binary RNG file which is passed to the `rgbgfx_test` program.
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
1. Ensure that the downstream project supports a `RGBDS` variable to build with
a non-system copy of RGBDS in some directory, i.e.
<code>make <var>&lt;target&gt;</var> RGBDS=<var>&lt;path/to/rgbds/&gt;</var></code>.
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.
Only [GNU Make](https://www.gnu.org/software/make/) is currently supported.
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
build with current RGBDS, then you can edit the project to build correctly, and
create a patch with `git diff` to be committed as
<code>test/external/patches/<var>&lt;project&gt;</var>.patch</code>.
## Container images