From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-dl1-f45.google.com (mail-dl1-f45.google.com [74.125.82.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 17E2738F647 for ; Thu, 12 Mar 2026 10:51:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.45 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773312709; cv=none; b=Ots7RY92HKG9v9Cu+6AN/YRUUnI/zAXkgl7nYS6p1PrmqcrtJDJCZJGhnKexwLaOQKS0ypP3/Ewa4DXv0OO40wjua7FZctjj7Vm4SXhbAZgAFFkzD5v3BicjEijKbakuq5EsQwfahS2YKAAVi4ptXgTvwFrO6zbnX28x+UvO230= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773312709; c=relaxed/simple; bh=r29hAxrbF+67wOT89L6BwuVdSkbuIkd93KeqR4v0D80=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=ednb5FNHeAvXsePbrZmjaxvU6GBh74GWDnJQV4yTykAY6sGaMn4olT/5obctVM5NmB+2nj6a9NJssMWUp77D359H6oR+PIqjxWxoixzOh0OedtL+WEpFrF2zSk4x7tK4gvKd5t7wNupLffBzvuHYhmMpOVptF4jS/l3D514DkSc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=NLyi0ljR; arc=none smtp.client-ip=74.125.82.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="NLyi0ljR" Received: by mail-dl1-f45.google.com with SMTP id a92af1059eb24-12776bebe9fso25109c88.1 for ; Thu, 12 Mar 2026 03:51:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1773312707; x=1773917507; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=vudMoe5tbm3Vk8y6iv0PO/6UeQcWquJrU0HrAJAdUN0=; b=NLyi0ljRA600lH12rsVT95Jg5mP6jAs3HrNfbfJPkV/dC+loY/5jfpu0PFRKDu87fm Bg3zXjhiQ1hbd1gsd3DP+xQZirj7TrcZz2Pp1SIxU8bDDcpEe+hyLnzZhXwvE55EIRqe vhMhIxf6U4H+lX8yppt4qSIlnaeKV+ouF9K3KDz0jVrsLMULH6VfirckVjMeaMb0OMrJ 3iy5RI/Ibh5KlY3oL6SOcM35f0NoxBwjYz8q8donb0OhzLniJOsPNh41YVZj0P3+75Xi gWq/u2wwraRIg7WbRBIZ1Bnuu2Z0JPaW5O/sTmHXUT3bQk+ODawR1zP6tr1bmZUAy2d1 QtXw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1773312707; x=1773917507; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=vudMoe5tbm3Vk8y6iv0PO/6UeQcWquJrU0HrAJAdUN0=; b=uk+5JByJwZOwnp67/Qx7EBEMSpPeYz1Z/Xf/R1LtdLryrYzgwjhUlHRcyzDUyM2nRD GFtKszsaKACTqWG5JC9FLNPTX9yAEm23tpsasNO+8vpRpOZ9XRKF7ry/oyYdQXiVn2gt UCDzn9cOs5s14GykWL4JmFOUbMH8gzo0nD+ivp0TkTdZmWLr6AJJtNo1BwDYPjSyC9uX KiVOQTI1rKnAbVx2yThaWYGrrbOKHYRckq6wY73+uhXdCAEEOFMHKad2tygpEJRXwzBz cPteOHoJhO1VHteBScW2ceFcqY8NB2Z1AEhimhgtFI21dcEVwskuEniWwlyBs6NtMbpU GMxg== X-Forwarded-Encrypted: i=1; AJvYcCXl67kfduN6nlXggRpXOaYqb6zAisFXvd+NckTTj/XHyrk+QUy03r/i8lhivdwAmw6mVShPamrF6+rN808=@vger.kernel.org X-Gm-Message-State: AOJu0YzrWtvca+bZritH2toMzuXHgrHUHjk9hD4k0wQQJ4NGFtc80GN6 pnJhoJShpnQYlySuUsxgj1oGkfs/mxeFkO56cAXmuZDjTM/nffNKnd71 X-Gm-Gg: ATEYQzw8/FHhxOz/dJxWt+USHLRiK2mJ+kxPxzw1VM93hpVtQg1eVv53Sm3L9z8vXLH RgQmO2iL2avXJvMRN1BQVr2ZgdkcQnByuHmnGM4lHkiVMD17I9pYPvNc0luqZ3USARK2V+DASUU QuZCSYp1YUAb6SXRMj3wajeBmPBhRmzqtBho5nJ+STRBRTd66tCKUqSYXuu5dnXBG1L7H2Rlk6L Pjf1J3ArAKFUzORrH5etykE+NTZhKe3LLQzmKI3dH3zMlDIStVwBuwJYfT2pSVcoSLHrGAta+KW gJMFYzj7JGSZfza8O2tNO5ono48KNvDPspAdU69cEjOsqJVAh2DVxwffEwaElc7SiEHhwMj0vUC vYFbfl2XNT37yH64cfRCgsMoqRwJvnBZIeYeXr71AqC/huqkSQyIj+EAQNOFRNcfPsgXrRwu3zM BuNSUlwU7wNRYeRbhh X-Received: by 2002:a05:7022:30d:b0:128:cc34:3616 with SMTP id a92af1059eb24-128e77a5612mr3112793c88.14.1773312707180; Thu, 12 Mar 2026 03:51:47 -0700 (PDT) Received: from localhost ([2804:d56:12ae:b200:67de:4395:bbdb:5257]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-128e7ce52aasm7936152c88.15.2026.03.12.03.51.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 12 Mar 2026 03:51:46 -0700 (PDT) From: Kenner de Azevedo dos Santos Miranda To: mst@redhat.com, jasowang@redhat.com Cc: xuanzhuo@linux.alibaba.com, eperezma@redhat.com, virtualization@lists.linux.dev, linux-kernel@vger.kernel.org, kenner.linuxdev@gmail.com Subject: [PATCH] virtio: fix kernel-doc warnings for virtio_device Date: Thu, 12 Mar 2026 06:51:39 -0400 Message-ID: <20260312105139.60811-1-kenner.linuxdev@gmail.com> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 --- 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