From b9a9ef2d5fa22c4e257f4d1befbc067029570211 Mon Sep 17 00:00:00 2001 From: David Steele Date: Fri, 21 Jun 2024 11:17:42 +0800 Subject: [PATCH] Clarify when code generation is run when modifying config.yaml. The contributing guide indicated that this happened at compile time but in fact it happens when test.pl is run. --- CONTRIBUTING.md | 2 +- doc/xml/contributing.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8ef43242..5aa040d34 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -642,7 +642,7 @@ repo-test-type: - `command-role` - defines the processes for which the option is valid. `main` indicates the option will be used by the main process and not be passed on to other local/remote processes. -At compile time, the `config.auto.h` file will be generated to contain the constants used for options in the code. For the C enums, any dashes in the option name will be removed, camel-cased and prefixed with `cfgOpt`, e.g. `repo-path` becomes `cfgOptRepoPath`. +When `test.pl` is run the `config.auto.h` file will be generated to contain the constants used for options in the code. For the C enums, any dashes in the option name will be removed, camel-cased and prefixed with `cfgOpt`, e.g. `repo-path` becomes `cfgOptRepoPath`. ### help.xml diff --git a/doc/xml/contributing.xml b/doc/xml/contributing.xml index 73c91ad58..2b14b3338 100644 --- a/doc/xml/contributing.xml +++ b/doc/xml/contributing.xml @@ -719,7 +719,7 @@ run 8/1 ------------- L2285 no current backups command-role - defines the processes for which the option is valid. main indicates the option will be used by the main process and not be passed on to other local/remote processes. -

At compile time, the config.auto.h file will be generated to contain the constants used for options in the code. For the C enums, any dashes in the option name will be removed, camel-cased and prefixed with cfgOpt, e.g. repo-path becomes cfgOptRepoPath.

+

When test.pl is run the config.auto.h file will be generated to contain the constants used for options in the code. For the C enums, any dashes in the option name will be removed, camel-cased and prefixed with cfgOpt, e.g. repo-path becomes cfgOptRepoPath.