[pulseaudio-discuss] [PATCH v3] pulse: Document client libraries logging behavior

[Tanu Kaskinen]

On Wed, 2015-08-12 at 22:33 +0200, Ahmed S. Darwish wrote:
> Document how to modify the client libraries logging behvaior
> using any of the PA-specific environment variables.
> 
> Using the `PULSE_LOG_*'environment variables makes debugging
> and tracing PA applications quite easy, thus the need for an
> official documentation text.
> 
> Signed-off-by: Ahmed S. Darwish <darwish.07 at gmail.com>
> ---
>  src/pulse/pulseaudio.h | 34 ++++++++++++++++++++++++++++++++++
>  1 file changed, 34 insertions(+)

Thanks for the patch! I have a small complaint about one thing:

> + *  - `PULSE_LOG_NO_RATE_LIMIT`: If defined, do not rate limit the logging
> + *     output of any PulseAudio component or module. This is especially
> + *     true for the udev audio hardware detection module, where a potential
> + *     for excessive logging output exists.


This documentation is aimed at client developers, so I think talking
about module logging isn't really appropriate here. Also, I don't
remember rate limiting having effect on the udev module logging in
particular, even though it generates lots of output.

I suggest the following text: "If defined, do not rate limit the
logging output. Rate limiting skips certain log messages when their
frequency is considered too high." How does that sound to you?

-- 
Tanu