[alsa-devel] [PATCH] ALSA: compress: fix documentation errors

[Takashi Iwai]

At Tue, 28 Oct 2014 21:25:13 +0530,
Vinod Koul wrote:
> 
> Some structure documentation was not right so fix it now
> 
> Reported-by: kbuild test robot <fengguang.wu at intel.com>
> Signed-off-by: Vinod Koul <vinod.koul at intel.com>

Thanks, applied.


Takashi

> ---
>  include/sound/compress_driver.h |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/include/sound/compress_driver.h b/include/sound/compress_driver.h
> index ae6c3b8..396e8f7 100644
> --- a/include/sound/compress_driver.h
> +++ b/include/sound/compress_driver.h
> @@ -42,12 +42,11 @@ struct snd_compr_ops;
>   * @buffer_size: size of the above buffer
>   * @fragment_size: size of buffer fragment in bytes
>   * @fragments: number of such fragments
> - * @hw_pointer: offset of last location in buffer where DSP copied data
> - * @app_pointer: offset of last location in buffer where app wrote data
>   * @total_bytes_available: cumulative number of bytes made available in
>   *	the ring buffer
>   * @total_bytes_transferred: cumulative bytes transferred by offload DSP
>   * @sleep: poll sleep
> + * @private_data: driver private data pointer
>   */
>  struct snd_compr_runtime {
>  	snd_pcm_state_t state;
> @@ -94,6 +93,8 @@ struct snd_compr_stream {
>   * This can be called in during stream creation only to set codec params
>   * and the stream properties
>   * @get_params: retrieve the codec parameters, mandatory
> + * @set_metadata: Set the metadata values for a stream
> + * @get_metadata: retreives the requested metadata values from stream
>   * @trigger: Trigger operations like start, pause, resume, drain, stop.
>   * This callback is mandatory
>   * @pointer: Retrieve current h/w pointer information. Mandatory
> -- 
> 1.7.0.4
>