[pulseaudio-discuss] [PATCH] Some trivial fixes for some documentation typos

Mads Kiilerich mads at kiilerich.com
Fri Dec 25 05:55:16 PST 2009 

Ping?

/Mads


mads at kiilerich.com wrote, On 12/11/2009 04:20 PM:
> Note the FIXME on pa_asyncq_before_poll_post - I really don't understand what
> Lennart meant there.
>
> Note also the willneed/will_need inconsistency. I guess it could be nice to ASAP
> choose one of them and introduce a backward compatibility hack for the other.
>
> The issues was mostly found with:
> for a in $(grep -r '^[ /]\*.*()' $(
> 	find -name '*.[ch]') |
> 	sed 's,^.* \([^ ]*\)().*$,\1,g' |
> 	sort |
> 	uniq |
> 	grep ^pa_)
> do
> 	grep -rq "^.[^*].*\<$a(" $(find * -name '*.h') || echo $a
> done
>
> diff --git a/src/pulse/def.h b/src/pulse/def.h
> --- a/src/pulse/def.h
> +++ b/src/pulse/def.h
> @@ -63,6 +63,7 @@
>   #define PA_CONTEXT_SETTING_NAME PA_CONTEXT_SETTING_NAME
>   #define PA_CONTEXT_READY PA_CONTEXT_READY
>   #define PA_CONTEXT_FAILED PA_CONTEXT_FAILED
> +#define PA_CONTEXT_TERMINATED PA_CONTEXT_TERMINATED
>   #define PA_CONTEXT_IS_GOOD PA_CONTEXT_IS_GOOD
>   /** \endcond */
>
> @@ -351,7 +352,7 @@
>        * that may be. Initialize to 0 to enable manual start/stop
>        * control of the stream. This means that playback will not stop
>        * on underrun and playback will not start automatically. Instead
> -     * pa_stream_corked() needs to be called explicitly. If you set
> +     * pa_stream_cork() needs to be called explicitly. If you set
>        * this value to 0 you should also set PA_STREAM_START_CORKED. */
>
>       uint32_t minreq;
> diff --git a/src/pulse/introspect.h b/src/pulse/introspect.h
> --- a/src/pulse/introspect.h
> +++ b/src/pulse/introspect.h
> @@ -460,7 +460,7 @@
>       pa_proplist *proplist;               /**<  Property list */
>   } pa_card_info;
>
> -/** Callback prototype for pa_context_get_card_info() and friends \since 0.9.15 */
> +/** Callback prototype for pa_context_get_card_info_...() \since 0.9.15 */
>   typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
>
>   /** Get information about a card by its index \since 0.9.15 */
> diff --git a/src/pulse/proplist.h b/src/pulse/proplist.h
> --- a/src/pulse/proplist.h
> +++ b/src/pulse/proplist.h
> @@ -325,7 +325,7 @@
>    * specified key name. \since 0.9.11 */
>   int pa_proplist_unset(pa_proplist *p, const char *key);
>
> -/** Similar to pa_proplist_remove() but takes an array of keys to
> +/** Similar to pa_proplist_unset() but takes an array of keys to
>    * remove. The array should be terminated by a NULL pointer. Return -1
>    * on failure, otherwise the number of entries actually removed (which
>    * might even be 0, if there where no matching entries to
> diff --git a/src/pulse/simple.h b/src/pulse/simple.h
> --- a/src/pulse/simple.h
> +++ b/src/pulse/simple.h
> @@ -82,8 +82,8 @@
>    *
>    * \li pa_simple_drain() - Will wait for all sent data to finish playing.
>    * \li pa_simple_flush() - Will throw away all data currently in buffers.
> - * \li pa_simple_get_playback_latency() - Will return the total latency of
> - *                                        the playback pipeline.
> + * \li pa_simple_get_latency() - Will return the total latency of
> + *                               the playback pipeline.
>    *
>    * \section cleanup_sec Cleanup
>    *
> diff --git a/src/pulse/stream.h b/src/pulse/stream.h
> --- a/src/pulse/stream.h
> +++ b/src/pulse/stream.h
> @@ -289,7 +289,7 @@
>    * issued on the others.
>    *
>    * To synchronize a stream to another, just pass the "master" stream
> - * as last argument to pa_stream_connect_playack(). To make sure that
> + * as last argument to pa_stream_connect_playback(). To make sure that
>    * the freshly created stream doesn't start playback right-away, make
>    * sure to pass PA_STREAM_START_CORKED and - after all streams have
>    * been created - uncork them all with a single call to
> @@ -716,7 +716,7 @@
>
>   /** Change the stream sampling rate during playback. You need to pass
>    * PA_STREAM_VARIABLE_RATE in the flags parameter of
> - * pa_stream_connect() if you plan to use this function. Only valid
> + * pa_stream_connect_...() if you plan to use this function. Only valid
>    * after the stream has been connected successfully and if the server
>    * is at least PulseAudio 0.9.8. \since 0.9.8 */
>   pa_operation *pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata);
> diff --git a/src/pulse/volume.h b/src/pulse/volume.h
> --- a/src/pulse/volume.h
> +++ b/src/pulse/volume.h
> @@ -149,7 +149,7 @@
>   char *pa_cvolume_snprint(char *s, size_t l, const pa_cvolume *c);
>
>   /** Maximum length of the strings returned by
> - * pa_cvolume_snprint_dB(). Please note that this value can change with
> + * pa_sw_cvolume_snprint_dB(). Please note that this value can change with
>    * any release without warning and without being considered API or ABI
>    * breakage. You should not use this definition anywhere where it
>    * might become part of an ABI. \since 0.9.13 */
> @@ -169,7 +169,7 @@
>   char *pa_volume_snprint(char *s, size_t l, pa_volume_t v);
>
>   /** Maximum length of the strings returned by
> - * pa_volume_snprint_dB(). Please note that this value can change with
> + * pa_sw_volume_snprint_dB(). Please note that this value can change with
>    * any release without warning and without being considered API or ABI
>    * breakage. You should not use this definition anywhere where it
>    * might become part of an ABI. \since 0.9.15 */
> @@ -268,7 +268,7 @@
>   #ifdef INFINITY
>   #define PA_DECIBEL_MININFTY ((double) -INFINITY)
>   #else
> -/** This floor value is used as minus infinity when using pa_volume_{to,from}_dB(). */
> +/** This floor value is used as minus infinity when using pa_sw_volume_to_dB() / pa_sw_volume_from_dB(). */
>   #define PA_DECIBEL_MININFTY ((double) -200.0)
>   #endif
>
> diff --git a/src/pulsecore/asyncq.h b/src/pulsecore/asyncq.h
> --- a/src/pulsecore/asyncq.h
> +++ b/src/pulsecore/asyncq.h
> @@ -49,7 +49,7 @@
>   int pa_asyncq_push(pa_asyncq *q, void *p, pa_bool_t wait);
>
>   /* Similar to pa_asyncq_push(), but if the queue is full, postpone it
> - * locally and delay until pa_asyncq_before_poll_post() */
> + * locally and delay until pa_asyncq_before_poll_post() ???FIXME */
>   void pa_asyncq_post(pa_asyncq*l, void *p);
>
>   /* For the reading side */
> diff --git a/src/pulsecore/aupdate.h b/src/pulsecore/aupdate.h
> --- a/src/pulsecore/aupdate.h
> +++ b/src/pulsecore/aupdate.h
> @@ -39,7 +39,7 @@
>
>   /* Will return 0, or 1, depending which copy of the data the caller
>    * should modify. Each time called this will return the opposite of
> - * the previous pa_aupdate_write_begin()/pa_aupdate_write_swap()
> + * the previous pa_aupdate_write_begin() / pa_aupdate_write_swap()
>    * call. Should only be called between pa_aupdate_write_begin() and
>    * pa_aupdate_write_end() */
>   unsigned pa_aupdate_write_swap(pa_aupdate *a);
> diff --git a/src/pulsecore/memblockq.h b/src/pulsecore/memblockq.h
> --- a/src/pulsecore/memblockq.h
> +++ b/src/pulsecore/memblockq.h
> @@ -165,7 +165,7 @@
>   void pa_memblockq_apply_attr(pa_memblockq *memblockq, const pa_buffer_attr *a);
>   void pa_memblockq_get_attr(pa_memblockq *bq, pa_buffer_attr *a);
>
> -/* Call pa_memchunk_willneed() for every chunk in the queue from the current read pointer to the end */
> +/* Call pa_memchunk_will_need() for every chunk in the queue from the current read pointer to the end */
>   void pa_memblockq_willneed(pa_memblockq *bq);
>
>   /* Check whether the memblockq is completely empty, i.e. no data
> _______________________________________________
> pulseaudio-discuss mailing list
> pulseaudio-discuss at mail.0pointer.de
> https://tango.0pointer.de/mailman/listinfo/pulseaudio-discuss
>

More information about the pulseaudio-discuss mailing list