1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-18 04:58:51 +02:00

Clarify intended usage of harnessCfgLoadRaw().

This commit is contained in:
David Steele 2020-10-24 11:16:06 -04:00
parent 76cfd8ca70
commit 80a770ed2e

View File

@ -13,7 +13,8 @@ Load a test configuration without any side effects
There's no need to open log files, acquire locks, reset log levels, etc.
***********************************************************************************************************************************/
// Low-level version used in a few places to simulate special cases and error conditions. Most tests should use harnessCfgLoad().
// Low-level version used when it is important that only the options set explicity by the test are present in the config. The
// additional options set by harnessCfgLoad() can make these tests harder to write. Most tests should use harnessCfgLoad().
void harnessCfgLoadRaw(unsigned int argListSize, const char *argList[]);
// Automatically adds the exe, command (and role), lock-path, and log-path so executing the binary works locally or in a container.