From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 29CCB36C0D1 for ; Thu, 19 Mar 2026 15:26:44 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.129.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773934009; cv=none; b=NKVE6XyallZ6KZDnu+abpw/J74F8px9NkOCw2RCqvnTbcEdCvriGikzwg5+V/QmzEN+Vztdh/ut7P0Pl9P25h74aXlVGQbxqRAXDI1OSpLCs2sgTBsUg8WjG0nsd4lT/AVhDQI+l7Mhh+pAB1ea6wd5biK4MCgfkNhS5TEt3RZY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773934009; c=relaxed/simple; bh=8u9XVghpeZayjXE20GtvjRqRjcPfiLDqL51fDWUW2GA=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=W32jCTJRUkbuByhEEIgF1pemuM8YKQfIlzqff8mX4tMR3PsZU4mFeFGBs9P00MwZ0ta4qV8voQ9u77I2d7XMXyjoasXmX8KgvoV4lBllijiJ4vkcIWjphkajFTtEw1Dt5lBGRlThWbl4M8xrfKLW6it+1niL7tnfVyBt/tZRcJg= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=VbJULAXv; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b=m3w7bpRH; arc=none smtp.client-ip=170.10.129.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="VbJULAXv"; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b="m3w7bpRH" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1773934003; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=aqMFvMUuTu6qfzQanxBGrjvh23hJYBpTzo7fMX6Yp2Y=; b=VbJULAXvFoRbp8qZewcZ3LHQn38KN56ORJxj2XLvvdp37e3IS0oYoak1VesxgbihQdfbMZ 8d9ZerkmEo8kVBvyX9lNUQIfk7w6ss9t3coe19O1lwKvDfWnEqEpKrivxWshx86MFrqYrR tD4GXy4TodCle/0x1undLS9UW4Wei7A= Received: from mail-wr1-f69.google.com (mail-wr1-f69.google.com [209.85.221.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-613-hsWLxOzEPj61w_PBHsOVkQ-1; Thu, 19 Mar 2026 11:26:42 -0400 X-MC-Unique: hsWLxOzEPj61w_PBHsOVkQ-1 X-Mimecast-MFC-AGG-ID: hsWLxOzEPj61w_PBHsOVkQ_1773934001 Received: by mail-wr1-f69.google.com with SMTP id ffacd0b85a97d-43b4730dad8so953898f8f.3 for ; Thu, 19 Mar 2026 08:26:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=google; t=1773934001; x=1774538801; darn=vger.kernel.org; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=aqMFvMUuTu6qfzQanxBGrjvh23hJYBpTzo7fMX6Yp2Y=; b=m3w7bpRHHuMkhuw5Kyyi4ddUyq2noevlcwVO2tr9DmNMvlmVYd+uIYK1c8EoVN99yc qPDIvfq4oa63XV5wpaWpOuqhWjiNigmIzG6rIvW3EBHQ936Nu4R0ArfzgmvM+z/oxskP esjT07N7Pqvn3YXAP1htHJiCC7VsQEyeUHTsWS2hULFrg2rW3F7H/yYX87+SV42WVY56 a74LSF72Yd11A3GQQ1UpxWN7qigTEKWskiHV8HU34Hmct8L6m0UXO6LhKQsRxCzJGS5D /Gv5eUj37IPGW4VH6r1FesUFX2Qud6qKjVUNBZHlFRF523p7b4Pkci/9X9OxzkJWSxnY fn/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1773934001; x=1774538801; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-gg:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=aqMFvMUuTu6qfzQanxBGrjvh23hJYBpTzo7fMX6Yp2Y=; b=aSN0h+YBFWgMpbHbAjTge/Y54yOjjsH/EsaRH+mGkj3Qnr1C5cr55Y9wvNUJrqHO4w 2fZGlqKCpTTZjAafC7sgI2JeWin8cvKzK6V2WgiAqPTcdYj26nQ8NjgvSviYqrCoVcAP 5680LxZOtA5vke5bmMGX4u+BnRjpz6HM3z1gEBgTNSjXtbAddHS0zgsRJCOcEayQKzjx cRiiS48aEZj9Ce4gVf3HbErKrZbNsq56U1KT1DpE980LCxYos6mqjSCPEQPfOD3MAEwg hjTj7F+5X35MLeGUkqrB9w+tLFssom9ScL3nujY+6dnZhRib/7IXEY7HMdjafhw5pjCn 0Vgw== X-Forwarded-Encrypted: i=1; AJvYcCV5/buyHqJdXSFQEh3qWeZKakFgHDQV8UiYrHUmKq09X9PIOjg3l0HWypfD51qwy8HnjhhexV8odktvB58=@vger.kernel.org X-Gm-Message-State: AOJu0Yw6OkusWjXmh/1dPPQ+o8fiXRvw++Bdv4qtijQQ8FnJh10gC7Ry r2xi1AYcFmQZNhnXB8POxcM7NIlSyyD5mxRzGRTbkgl8s5VhQGh9x91JgSeDB/0VQ5VtUqU4Y25 7RkcYL6Gw+MziMIf9QEGt3J4H9vUKGJ0FOxR5wReUDX/Gd+Te6p0Iz0+bPw7X6wSm6g== X-Gm-Gg: ATEYQzwck35YaE+GROhgQa0k9vuNgMUHnggUW4mhn0W4SaGHGuDZF1L9ACMFKZDI7ap O1AncNBX/RZ9TInraaQtk6pJFWWsceu9HK1pYWi0Um0NqYqIUuaT1vsFRPBWIyP1Fk1L2ey8Yoj SkOOrYk2HO+lxDGydWAsMQ6Y3G7I9juaNAX8JU8zv4rmrpQXADsZCEJ/RPQhsxWyt81DT87NVby KFjd30CBJ8whTpv8urv31vcRPake7Ub9ONhRb62bDO4FFzKQ4cXIWqZ54yvYivr2zaSqlUtpib9 bYDH979AhGiN4FQhLHHnFUUvDn1VoyJy5eCh6UZ+G0I9EAeHjsROxoQu3Axu7PqGXrlcql/jO4y jlDinSwhuiXtgeVPj X-Received: by 2002:a05:6000:2285:b0:439:d8e2:9a40 with SMTP id ffacd0b85a97d-43b527cba00mr12920957f8f.55.1773934001097; Thu, 19 Mar 2026 08:26:41 -0700 (PDT) X-Received: by 2002:a05:6000:2285:b0:439:d8e2:9a40 with SMTP id ffacd0b85a97d-43b527cba00mr12920891f8f.55.1773934000426; Thu, 19 Mar 2026 08:26:40 -0700 (PDT) Received: from redhat.com ([2a0d:6fc0:1525:da00:3ac2:1a22:72ff:4256]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-43b518a3d78sm18187742f8f.34.2026.03.19.08.26.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 19 Mar 2026 08:26:39 -0700 (PDT) Date: Thu, 19 Mar 2026 11:26:37 -0400 From: "Michael S. Tsirkin" To: Kenner de Azevedo dos Santos Miranda Cc: jasowang@redhat.com, xuanzhuo@linux.alibaba.com, eperezma@redhat.com, virtualization@lists.linux.dev, linux-kernel@vger.kernel.org Subject: Re: [PATCH] virtio: fix kernel-doc warnings for virtio_device Message-ID: <20260319112552-mutt-send-email-mst@kernel.org> References: <20260312105139.60811-1-kenner.linuxdev@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20260312105139.60811-1-kenner.linuxdev@gmail.com> On Thu, Mar 12, 2026 at 06:51:39AM -0400, Kenner de Azevedo dos Santos Miranda wrote: > The following warnings were reported when running 'make htmldocs': > > WARNING: ./include/linux/virtio.h:188 struct member 'map' > not described in 'virtio_device' > > WARNING: ./include/linux/virtio.h:188 struct member > 'VIRTIO_DECLARE_FEATURES(features' not described in > 'virtio_device' > > WARNING: ./include/linux/virtio.h:188 struct member 'vmap' > not described in 'virtio_device' > > Document the map and vmap fields in struct virtio_device. > > Also avoid kernel-doc confusion caused by the VIRTIO_DECLARE_FEATURES() > macro by documenting the logical @features field. > > After these changes, running 'make htmldocs' no longer reports warnings > for map, vmap, or VIRTIO_DECLARE_FEATURES(). > > Signed-off-by: Kenner de Azevedo dos Santos Miranda I will queue this. Thanks! > --- > include/linux/virtio.h | 5 ++++- > 1 file changed, 4 insertions(+), 1 deletion(-) > > diff --git a/include/linux/virtio.h b/include/linux/virtio.h > index 3bbc4cb6a672..074d36453177 100644 > --- a/include/linux/virtio.h > +++ b/include/linux/virtio.h > @@ -157,11 +157,13 @@ struct virtio_admin_cmd { > * @id: the device type identification (used to match it with a driver). > * @config: the configuration ops for this device. > * @vringh_config: configuration ops for host vrings. > + * @map: virtio specific mapping operations used by the device or transport. > * @vqs: the list of virtqueues for this device. > * @features: the 64 lower features supported by both driver and device. > * @features_array: the full features space supported by both driver and > - * device. > + * device. > * @priv: private pointer for the driver's use. > + * @vmap: mapping token passed to virtio mapping helpers and transport ops. > * @debugfs_dir: debugfs directory entry. > * @debugfs_filter_features: features to be filtered set by debugfs. > */ > @@ -179,6 +181,7 @@ struct virtio_device { > const struct vringh_config_ops *vringh_config; > const struct virtio_map_ops *map; > struct list_head vqs; > + /* See @features */ > VIRTIO_DECLARE_FEATURES(features); > void *priv; > union virtio_map vmap; > -- > 2.43.0