Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

ALSA: core: Fix missing return value comments for kernel docs

Each kernel doc comment expects the definition of the return value in
a proper format. This patch adds or fixes the missing entries for the
remaining ALSA core API functions.

Link: https://lore.kernel.org/r/20220713104759.4365-8-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>

+18 -2
+2
sound/core/device.c
··· 247 247 * device, either @SNDRV_DEV_BUILD, @SNDRV_DEV_REGISTERED or 248 248 * @SNDRV_DEV_DISCONNECTED is returned. 249 249 * Or for a non-existing device, -1 is returned as an error. 250 + * 251 + * Return: the current state, or -1 if not found 250 252 */ 251 253 int snd_device_get_state(struct snd_card *card, void *device_data) 252 254 {
+2
sound/core/info.c
··· 868 868 * 869 869 * This proc file entry will be registered via snd_card_register() call, and 870 870 * it will be removed automatically at the card removal, too. 871 + * 872 + * Return: zero if successful, or a negative error code 871 873 */ 872 874 int snd_card_rw_proc_new(struct snd_card *card, const char *name, 873 875 void *private_data,
+10
sound/core/init.c
··· 215 215 * via snd_card_free() call in the error; otherwise it may lead to UAF due to 216 216 * devres call orders. You can use snd_card_free_on_error() helper for 217 217 * handling it more easily. 218 + * 219 + * Return: zero if successful, or a negative error code 218 220 */ 219 221 int snd_devm_card_new(struct device *parent, int idx, const char *xid, 220 222 struct module *module, size_t extra_size, ··· 251 249 * This function handles the explicit snd_card_free() call at the error from 252 250 * the probe callback. It's just a small helper for simplifying the error 253 251 * handling with the managed devices. 252 + * 253 + * Return: zero if successful, or a negative error code 254 254 */ 255 255 int snd_card_free_on_error(struct device *dev, int ret) 256 256 { ··· 374 370 * 375 371 * Returns a card object corresponding to the given index or NULL if not found. 376 372 * Release the object via snd_card_unref(). 373 + * 374 + * Return: a card object or NULL 377 375 */ 378 376 struct snd_card *snd_card_ref(int idx) 379 377 { ··· 614 608 * resource immediately, but tries to disconnect at first. When the card 615 609 * is still in use, the function returns before freeing the resources. 616 610 * The card resources will be freed when the refcount gets to zero. 611 + * 612 + * Return: zero if successful, or a negative error code 617 613 */ 618 614 int snd_card_free_when_closed(struct snd_card *card) 619 615 { ··· 841 833 * snd_card_add_dev_attr - Append a new sysfs attribute group to card 842 834 * @card: card instance 843 835 * @group: attribute group to append 836 + * 837 + * Return: zero if successful, or a negative error code 844 838 */ 845 839 int snd_card_add_dev_attr(struct snd_card *card, 846 840 const struct attribute_group *group)
+2 -1
sound/core/isadma.c
··· 116 116 * @dma: the dma number 117 117 * @name: the name string of the requester 118 118 * 119 - * Returns zero on success, or a negative error code. 120 119 * The requested DMA will be automatically released at unbinding via devres. 120 + * 121 + * Return: zero on success, or a negative error code 121 122 */ 122 123 int snd_devm_request_dma(struct device *dev, int dma, const char *name) 123 124 {
+2 -1
sound/core/vmaster.c
··· 494 494 * @arg: optional function argument 495 495 * 496 496 * Apply the function @func to each follower kctl of the given vmaster kctl. 497 - * Returns 0 if successful, or a negative error code. 497 + * 498 + * Return: 0 if successful, or a negative error code 498 499 */ 499 500 int snd_ctl_apply_vmaster_followers(struct snd_kcontrol *kctl, 500 501 int (*func)(struct snd_kcontrol *vfollower,