From e55c35af05f0e8364060001f12974be90598edfa Mon Sep 17 00:00:00 2001 From: Joseph Cloutier Date: Sat, 7 May 2022 14:51:52 -0400 Subject: [PATCH] Document custom config.h file. --- project/lib/include/pixman/config.h | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/project/lib/include/pixman/config.h b/project/lib/include/pixman/config.h index fba96f3ca..654868f34 100644 --- a/project/lib/include/pixman/config.h +++ b/project/lib/include/pixman/config.h @@ -1,4 +1,19 @@ -/* config.h.in. Generated from configure.ac by autoheader. */ +/** + Modified version of config.h, customized for OpenFL/Lime. The conditional + compilation blocks allow this same file to be used across machines. + + Run autogen.sh to generate a new version of this file, but be warned that the + new version will lack any conditional compilation blocks, making it + machine-specific. (To run autogen.sh on Windows, see + https://docs.microsoft.com/en-us/windows/wsl/about .) + + With the new version generated: + + 1. Compare this file to project/lib/pixman/config.h. + 2. If you find a new `#define`, copy it to this file, placing it in a + conditional compilation block. Use the existing blocks as a guide. + 3. Update the version number(s) if they've changed. +**/ /* Define if building universal (internal helper macro) */ /* #undef AC_APPLE_UNIVERSAL_BUILD */