[igt-dev] [PATCH i-g-t v2] igt_core: Fix docs for SLOW_QUICK

[Dixit, Ashutosh]

On Thu, 18 Nov 2021 00:36:52 -0800, Petri Latvala wrote:
>
> The macro is for choosing between two values depending on whether IGT
> has been told it's running in simulation mode. The parameter names and
> their documentation was the opposite of what actually happened.
>
> The only user, gem_lut_handle, uses the macro correctly, having the
> "use this value in simulation mode" value as the second parameter.
>
> v2: Remove confusion on whether "slow" means "slow test" or "slow
> platform" by using "hw" and "sim" instead. (Ashutosh)

Reviewed-by: Ashutosh Dixit <ashutosh.dixit at intel.com>

> Signed-off-by: Petri Latvala <petri.latvala at intel.com>
> Cc: Arkadiusz Hiler <arek at hiler.eu>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Cc: Ashutosh Dixit <ashutosh.dixit at intel.com>
> ---
>  lib/igt_core.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/lib/igt_core.h b/lib/igt_core.h
> index 6b8dbf34..0aad161d 100644
> --- a/lib/igt_core.h
> +++ b/lib/igt_core.h
> @@ -1164,13 +1164,13 @@ void igt_install_exit_handler(igt_exit_handler_t fn);
>  bool igt_run_in_simulation(void);
>  /**
>   * SLOW_QUICK:
> - * @slow: value in simulation mode
> - * @quick: value in normal mode
> + * @sim: value in simulation mode
> + * @hw: value in normal mode
>   *
>   * Simple macro to select between two values (e.g. number of test rounds or test
>   * buffer size) depending upon whether i-g-t is run in simulation mode or not.
>   */
> -#define SLOW_QUICK(slow,quick) (igt_run_in_simulation() ? (quick) : (slow))
> +#define SLOW_QUICK(hw, sim) (igt_run_in_simulation() ? (sim) : (hw))