diff --git a/bt_secp256k1_i128.h b/bt_secp256k1_i128.h index 1af984c..a7c8fc7 100644 --- a/bt_secp256k1_i128.h +++ b/bt_secp256k1_i128.h @@ -4,23 +4,33 @@ // A machine generated single-header file of bitcoin-core/libsecp256k1 that is // compilable in C/C++ with minimal effort. // -// - By default ECMULT_WINDOW_SIZE is set to 15. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// Define the following desired macros in one and only one C/C++ file to enable +// the implementation in that translation unit. +// - BT_SECP256K1_IMPLEMENTATION +// Enable the single file library implementation in that translation unit // -// - By default ECMULT_GEN_PREC_BITS is set to 4. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// - BT_SECP256K1_DISABLE_WARNING_PRAGMAS +// Disable the extra compiler pragmas in this file that suppress some +// compiler warnings generated by the library for C++ compilers // -// - Define BT_SECP256K1_DISABLE_WARNING_PRAGMAS to disable the extra pragmas in -// this file that suppress some compiler warnings- since this is not really the -// concern of a machine generated single header file library, fixes should be sent -// upstream. +// - ECMULT_GEN_PREC_BITS +// By default ECMULT_GEN_PREC_BITS is set to 4 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. // -// - Define BT_SECP256K1_NO_PRECOMPUTED_TABLE to disable the precomputed table -// that was generated by building and running gen_context.c +// - ECMULT_WINDOW_SIZE +// By default ECMULT_WINDOW_SIZE is set to 15 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. +// +// Define the following desired macros before the header file +// - ENABLE_MODULE_ECDH +// - ENABLE_MODULE_RECOVERY +// - ENABLE_MODULE_EXTRAKEYS +// - ENABLE_MODULE_SCHNORRSIG +// Additional modules that are available in secp256k1 can be enabled by using +// these macros which ensure the additional API's are not pre-processed out +// of the file. // ----------------------------------------------------------------------------- // NOTE: License // ----------------------------------------------------------------------------- diff --git a/bt_secp256k1_i128_x86_64_asm.h b/bt_secp256k1_i128_x86_64_asm.h index d338b94..1911830 100644 --- a/bt_secp256k1_i128_x86_64_asm.h +++ b/bt_secp256k1_i128_x86_64_asm.h @@ -4,23 +4,33 @@ // A machine generated single-header file of bitcoin-core/libsecp256k1 that is // compilable in C/C++ with minimal effort. // -// - By default ECMULT_WINDOW_SIZE is set to 15. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// Define the following desired macros in one and only one C/C++ file to enable +// the implementation in that translation unit. +// - BT_SECP256K1_IMPLEMENTATION +// Enable the single file library implementation in that translation unit // -// - By default ECMULT_GEN_PREC_BITS is set to 4. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// - BT_SECP256K1_DISABLE_WARNING_PRAGMAS +// Disable the extra compiler pragmas in this file that suppress some +// compiler warnings generated by the library for C++ compilers // -// - Define BT_SECP256K1_DISABLE_WARNING_PRAGMAS to disable the extra pragmas in -// this file that suppress some compiler warnings- since this is not really the -// concern of a machine generated single header file library, fixes should be sent -// upstream. +// - ECMULT_GEN_PREC_BITS +// By default ECMULT_GEN_PREC_BITS is set to 4 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. // -// - Define BT_SECP256K1_NO_PRECOMPUTED_TABLE to disable the precomputed table -// that was generated by building and running gen_context.c +// - ECMULT_WINDOW_SIZE +// By default ECMULT_WINDOW_SIZE is set to 15 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. +// +// Define the following desired macros before the header file +// - ENABLE_MODULE_ECDH +// - ENABLE_MODULE_RECOVERY +// - ENABLE_MODULE_EXTRAKEYS +// - ENABLE_MODULE_SCHNORRSIG +// Additional modules that are available in secp256k1 can be enabled by using +// these macros which ensure the additional API's are not pre-processed out +// of the file. // ----------------------------------------------------------------------------- // NOTE: License // ----------------------------------------------------------------------------- diff --git a/bt_secp256k1_i64.h b/bt_secp256k1_i64.h index d6083fa..8e72cf7 100644 --- a/bt_secp256k1_i64.h +++ b/bt_secp256k1_i64.h @@ -4,23 +4,33 @@ // A machine generated single-header file of bitcoin-core/libsecp256k1 that is // compilable in C/C++ with minimal effort. // -// - By default ECMULT_WINDOW_SIZE is set to 15. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// Define the following desired macros in one and only one C/C++ file to enable +// the implementation in that translation unit. +// - BT_SECP256K1_IMPLEMENTATION +// Enable the single file library implementation in that translation unit // -// - By default ECMULT_GEN_PREC_BITS is set to 4. This is the default -// recommended value you'd get from building the library with "auto" settings. -// You may override this by defining this macro before defining the -// IMPLEMENTATION macro for this file. +// - BT_SECP256K1_DISABLE_WARNING_PRAGMAS +// Disable the extra compiler pragmas in this file that suppress some +// compiler warnings generated by the library for C++ compilers // -// - Define BT_SECP256K1_DISABLE_WARNING_PRAGMAS to disable the extra pragmas in -// this file that suppress some compiler warnings- since this is not really the -// concern of a machine generated single header file library, fixes should be sent -// upstream. +// - ECMULT_GEN_PREC_BITS +// By default ECMULT_GEN_PREC_BITS is set to 4 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. // -// - Define BT_SECP256K1_NO_PRECOMPUTED_TABLE to disable the precomputed table -// that was generated by building and running gen_context.c +// - ECMULT_WINDOW_SIZE +// By default ECMULT_WINDOW_SIZE is set to 15 if not defined. This is the +// default recommended value you'd get from building the library with +// "auto" settings. +// +// Define the following desired macros before the header file +// - ENABLE_MODULE_ECDH +// - ENABLE_MODULE_RECOVERY +// - ENABLE_MODULE_EXTRAKEYS +// - ENABLE_MODULE_SCHNORRSIG +// Additional modules that are available in secp256k1 can be enabled by using +// these macros which ensure the additional API's are not pre-processed out +// of the file. // ----------------------------------------------------------------------------- // NOTE: License // ----------------------------------------------------------------------------- diff --git a/bt_secp256k1_metaprogram.cpp b/bt_secp256k1_metaprogram.cpp index 311a892..f8fd59c 100644 --- a/bt_secp256k1_metaprogram.cpp +++ b/bt_secp256k1_metaprogram.cpp @@ -420,23 +420,33 @@ int main(int argc, char *argv[]) "// A machine generated single-header file of bitcoin-core/libsecp256k1 that is\n" "// compilable in C/C++ with minimal effort.\n" "//\n" - "// - By default ECMULT_WINDOW_SIZE is set to 15. This is the default\n" - "// recommended value you'd get from building the library with \"auto\" settings.\n" - "// You may override this by defining this macro before defining the\n" - "// IMPLEMENTATION macro for this file.\n" + "// Define the following desired macros in one and only one C/C++ file to enable\n" + "// the implementation in that translation unit.\n" + "// - BT_SECP256K1_IMPLEMENTATION\n" + "// Enable the single file library implementation in that translation unit\n" "//\n" - "// - By default ECMULT_GEN_PREC_BITS is set to 4. This is the default\n" - "// recommended value you'd get from building the library with \"auto\" settings.\n" - "// You may override this by defining this macro before defining the\n" - "// IMPLEMENTATION macro for this file.\n" + "// - BT_SECP256K1_DISABLE_WARNING_PRAGMAS\n" + "// Disable the extra compiler pragmas in this file that suppress some\n" + "// compiler warnings generated by the library for C++ compilers\n" "//\n" - "// - Define BT_SECP256K1_DISABLE_WARNING_PRAGMAS to disable the extra pragmas in\n" - "// this file that suppress some compiler warnings- since this is not really the\n" - "// concern of a machine generated single header file library, fixes should be sent\n" - "// upstream.\n" + "// - ECMULT_GEN_PREC_BITS \n" + "// By default ECMULT_GEN_PREC_BITS is set to 4 if not defined. This is the\n" + "// default recommended value you'd get from building the library with\n" + "// \"auto\" settings.\n" "//\n" - "// - Define BT_SECP256K1_NO_PRECOMPUTED_TABLE to disable the precomputed table\n" - "// that was generated by building and running gen_context.c\n" + "// - ECMULT_WINDOW_SIZE \n" + "// By default ECMULT_WINDOW_SIZE is set to 15 if not defined. This is the\n" + "// default recommended value you'd get from building the library with\n" + "// \"auto\" settings.\n" + "//\n" + "// Define the following desired macros before the header file\n" + "// - ENABLE_MODULE_ECDH\n" + "// - ENABLE_MODULE_RECOVERY\n" + "// - ENABLE_MODULE_EXTRAKEYS\n" + "// - ENABLE_MODULE_SCHNORRSIG\n" + "// Additional modules that are available in secp256k1 can be enabled by using\n" + "// these macros which ensure the additional API's are not pre-processed out\n" + "// of the file.\n" "// -----------------------------------------------------------------------------\n" "// NOTE: License\n" "// -----------------------------------------------------------------------------\n"