Re: [LTP] [PATCH v8 1/2] doc: Add missing API references to api_c_tests.rst

[Cyril Hrubis <chrubis@suse.cz>]

Hi!
Some of the fuzzy sync struct member descriptions were simplified too
much. Suggestions below.

>  /**
> - * The state of a two way synchronisation or race.
> + * struct tst_fzsync_pair - The state of a two way synchronisation or race.
> + * @avg_alpha: Rate at which old diff samples are forgotten (default 0.25).
> + * @a_start: Internal; Thread A start time.
> + * @b_start: Internal; Thread B start time.
> + * @a_end: Internal; Thread A end time.
> + * @b_end: Internal; Thread B end time.
> + * @diff_ss: Internal; Avg. difference between a_start and b_start.
> + * @diff_sa: Internal; Avg. difference between a_start and a_end.
> + * @diff_sb: Internal; Avg. difference between b_start and b_end.
> + * @diff_ab: Internal; Avg. difference between a_end and b_end.
> + * @spins: Internal; Number of spins while waiting for the slower thread.
> + * @spins_avg: Internal; Average spins stat.
> + * @delay: Internal; Number of spins to use in the delay.

We need to add this here (otherwise the information is lost):

A negative value delays thread A and a positive delays thread B.

> + * @delay_bias: Internal; Bias added to delay.  + * @sampling:
> Internal; Sampling state or remaining count.

			     ^ If possitive stores the number of samples
			     left. If zero or negative stores sampling
			     state.

> + * @min_samples: Minimum samples before random delays are calculated (default 1024).
> + * @max_dev_ratio: Maximum allowed proportional average deviation (default 0.1).
                          ^

Maximum allowed proportional average deviation, in range (0.0, 1.0),
before random delays are applied. It's ratio of average_deviation /
total_time (default 0.1 i.e. avg deviation at most 10%).


> + * @a_cntr: Internal; Atomic counter used by fzsync_pair_wait().
> + * @b_cntr: Internal; Atomic counter used by fzsync_pair_wait().
> + * @exit: Internal; Used by tst_fzsync_pair_exit() and fzsync_pair_wait().
> + * @exec_time_start: Internal; Test time remaining on tst_fzsync_pair_reset().
> + * @exec_loops: Maximum number of iterations to execute.
> + * @exec_loop: Internal; Current loop index.
> + * @thread_b: Internal; The second thread or 0.
> + * @yield_in_wait: Yield CPU while waiting on single-core machines.
                         ^
	              Yield CPU while waiting, set automatically on single-core
		      machines.


With these adjusted:

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp