From 623f3c25850d689c8017be48a4f9694725ecc6d1 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 3 Sep 2025 10:52:27 +1000 Subject: [PATCH] Docs: clarify intended use of build defines regarding --help --- source/creator/creator_args.cc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/creator/creator_args.cc b/source/creator/creator_args.cc index 674e644ae52..eada1e7ed24 100644 --- a/source/creator/creator_args.cc +++ b/source/creator/creator_args.cc @@ -82,6 +82,12 @@ /** * Support extracting arguments for all platforms (for documentation purposes). * These names match the upper case defines. + * + * \note these build-defines should only be used to exclude arguments + * from `--help` when those arguments are not handled at all. + * Where using them would be the same as passing in an unknown argument. + * It's possible scripts are shared between platforms, + * so it's preferable that known arguments are documented. */ struct BuildDefs { bool win32; @@ -818,6 +824,7 @@ static void print_help(bArgs *ba, bool all) BLI_args_print_arg_doc(ba, "--register-allusers"); BLI_args_print_arg_doc(ba, "--unregister"); BLI_args_print_arg_doc(ba, "--unregister-allusers"); + /* Windows only. */ BLI_args_print_arg_doc(ba, "--qos"); BLI_args_print_arg_doc(ba, "--version");