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.133.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 EE76A2686A0 for ; Fri, 26 Dec 2025 19:13:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1766776389; cv=none; b=Kp9cXXa82Zs1fn9bp1QNYIH5VRmfd96i4vA23xn2s6VKp8lYcEnofM8++tJTz48VaGo9ez9AUaSolxitaeL4iySLxu2IXL5BssLn0/mjm7yuJLw0JkLeYTY05/jmx8GaJVnj4kRij+UJ012lHQ+Pcxe9RwzsPc/RMoyU0mSMw9U= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1766776389; c=relaxed/simple; bh=lUMCmuczKMUXW6eGw5YTX4sf8AJhio3FKYtAAVRjSoQ=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=prPmq9ekqjgl1hfJQdlvf7bgAeJJYxozZVnoQbwgcO43BGRmOZca8yaArvUBah26yZF3y4VWdbxbC/wuhHr5T5XWa92PdZBD78iXLwjQnND2hwTshf2cAkizRrBKRIwXfxxtKTHPCSsPMuvTI2N1g0c2S/5YzizGhDjDCCG3Uz0= 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=I43bi9Hc; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b=RNes0Z2a; arc=none smtp.client-ip=170.10.133.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="I43bi9Hc"; dkim=pass (2048-bit key) header.d=redhat.com header.i=@redhat.com header.b="RNes0Z2a" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1766776386; 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=jCJExQzqs637ugyXIzruHJz549Yv0YnLyqIpS8e/QQE=; b=I43bi9HcZZuJ1Lt6LJ/HlQahpfUB0YCPVXT9Zr11ue8ueuxu62OtNxpffkH3ralvF23uqx z9+M48UizIBObvGqeoagBX7IAepcIM8s71gi2JBpHnslqFRQCxpmUjmeFP4rNlC7y5llfS tTLzkz48MI3ni7E2hN8I4JrJuSIFloI= Received: from mail-wm1-f71.google.com (mail-wm1-f71.google.com [209.85.128.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-570-Z3O7disNNMaBV1YW18Di0Q-1; Fri, 26 Dec 2025 14:13:05 -0500 X-MC-Unique: Z3O7disNNMaBV1YW18Di0Q-1 X-Mimecast-MFC-AGG-ID: Z3O7disNNMaBV1YW18Di0Q_1766776384 Received: by mail-wm1-f71.google.com with SMTP id 5b1f17b1804b1-4775e00b16fso17462075e9.2 for ; Fri, 26 Dec 2025 11:13:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=google; t=1766776384; x=1767381184; 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=jCJExQzqs637ugyXIzruHJz549Yv0YnLyqIpS8e/QQE=; b=RNes0Z2aE/Fqj9Uxh8tDHAe5iysDAQxVvWqf44K9W+Q3m7b7X3WBV9P99JrhbngUMc GR97whiOC78PiWGKZLSC6fXG/B3vHNLbOIgGBC28Q0cuY8ARfF5mpvVggPLMZPmmY50d xjdWLz1xCMfR3bAM4PYzVlyiTwDFtSj8k5ve5Q9P/0erXHYdvSoeVtqh6GWTe/fAkucW 7iOrQL7nU6WQgmhrmPY10UOcq03mwRUZLqWyL7z5WQ0MGcPoJy5N5iv8/PSIKTY93RpM qk6Tm9jWw7nSMep8slYVyP1EUdeRdxHpTfTsXI/OhUNidtfPFoaL8GXt1RRgfrQadSqO tjSw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1766776384; x=1767381184; 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=jCJExQzqs637ugyXIzruHJz549Yv0YnLyqIpS8e/QQE=; b=KZFix+VDHNI7Bn+0Vvm+eLcqtXEIoBHJXljFOOj6W8wbTqJA1dvypsG/l1mABqYcn8 YOXuf7lMHF/uelK+nEU5pKHul315ynWHPIdQkd/QjtkuOAeZRYsnz6sJMBmyoysLGnmw qoMMlC4CnpXBTIYldAjmEo2h/peHkfgxNlok3OLextCr/13p7xwGqqD9mCOlBAIMxxFQ d+yJW/1JMrmKdNB5BvdsqeSLZVTodhqsexfWQxiQlTujTLjDC2acj09VvZ8Fl99Vvckv 8yDHzjFz0frXYEjU7MM8d8R3oh2oMdqBMrElCGZQtOZu8eISwIM1CwwwlbhcU3fB38YQ m63w== X-Gm-Message-State: AOJu0Yxib0NPBYm6hengoHWBMsAFNhVThanI+u5Q63VXM6/MGuCO0XkK bCVVeyV77AD75EtfoAuRFAumkrRdnRz86d3nHWVhjKe6mCN3LpnRPa0oTMXrt8zVeo54e/0PVQX OjOJ6JRXgYufoG6WMloAt4rGiy8+wnRYjlip6kig7nG/GKOFsVgafW6g3jTT7aVeefQ== X-Gm-Gg: AY/fxX6TBy73/so4SFHuzFVbRuOTlRMIQA012E7/bOq3xXDUS2KnlqBBMXgSi4E/YWF 5E9J1e5CBbkd+zlbZC40b4bOxN6r1zUMuUg5o9cN/UzusoiPWnSl2C0RVF7LvUXBVJpnVypcP3E GliHt5DvfnE5kxrQJgxDuDwLKY/sjJ5EnpiN8SBl5xeVHQpqSmaHIj1MHqM1ESJCLw6yQhgEtRk 8Q0Mw/RP70TF4Ce5wrwcU8VsMmKQfNgKII28neMSItCwWJzdwcX4enMQZ97Lc5BOQk70XU39mVu kKzA8Fdje7V5KjRjqvTrR3Jt0b5x9PonFgY+eHCGAJ8k9wybrVGfBVAtKmfw3yB2wBiX+qSCeoF Q2112bFnXsJLlB/LiXmeWBA2oJIvf+kLlbg== X-Received: by 2002:a05:600c:4746:b0:479:33be:b23e with SMTP id 5b1f17b1804b1-47d34de4cacmr152042905e9.17.1766776384250; Fri, 26 Dec 2025 11:13:04 -0800 (PST) X-Google-Smtp-Source: AGHT+IGaJOGoIgep+VQjNLBDcLc9sEzjktuiVWY5kDlSwfdV30VOKaMZG2W2eFwHzlOC0f0TIvKVjQ== X-Received: by 2002:a05:600c:4746:b0:479:33be:b23e with SMTP id 5b1f17b1804b1-47d34de4cacmr152042655e9.17.1766776383751; Fri, 26 Dec 2025 11:13:03 -0800 (PST) Received: from redhat.com (IGLD-80-230-31-118.inter.net.il. [80.230.31.118]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-47d19346d33sm413964195e9.3.2025.12.26.11.13.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Dec 2025 11:13:03 -0800 (PST) Date: Fri, 26 Dec 2025 14:13:00 -0500 From: "Michael S. Tsirkin" To: Bagas Sanjaya Cc: Linux Kernel Mailing List , Linux Virtualization , Jason Wang , Xuan Zhuo , Eugenio =?iso-8859-1?Q?P=E9rez?= Subject: Re: [PATCH v2] virtio: Describe @map and @vmap members in virtio_device struct Message-ID: <20251226140725-mutt-send-email-mst@kernel.org> References: <20251219031647.25264-1-bagasdotme@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: <20251219031647.25264-1-bagasdotme@gmail.com> On Fri, Dec 19, 2025 at 10:16:47AM +0700, Bagas Sanjaya wrote: > Sphinx reports kernel-doc warnings: > > WARNING: ./include/linux/virtio.h:181 struct member 'map' not described in 'virtio_device' > WARNING: ./include/linux/virtio.h:181 struct member 'vmap' not described in 'virtio_device' > > Describe these members. > > Fixes: bee8c7c24b7373 ("virtio: introduce map ops in virtio core") > Acked-by: Michael S. Tsirkin > Acked-by: Jason Wang > Signed-off-by: Bagas Sanjaya Well I was going to apply and now I have second thoughts. The patch does describe the members, it just does not describe them well. for example, > --- > This patch is split from kernel-doc fixup series [1]. > > Changes since v1 [2]: > > - Apply review trailers (Michael, Jason) > > [1]: https://lore.kernel.org/lkml/20251215113903.46555-1-bagasdotme@gmail.com/ > [2]: https://lore.kernel.org/lkml/20251215113903.46555-7-bagasdotme@gmail.com/ > > include/linux/virtio.h | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/include/linux/virtio.h b/include/linux/virtio.h > index 132a474e59140a..68ead8fda9c921 100644 > --- a/include/linux/virtio.h > +++ b/include/linux/virtio.h > @@ -150,11 +150,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: configuration ops for device's mapping buffer there's no "mapping buffer" that needs configuration. the type tells it all: * struct virtio_map_ops - operations for mapping buffer for a virtio device > * @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. > * @priv: private pointer for the driver's use. > + * @vmap: device virtual map this one is not a "virtual map" either. more a "device or domain used for mapping memory" > * @debugfs_dir: debugfs directory entry. > * @debugfs_filter_features: features to be filtered set by debugfs. > */ > > base-commit: ea1013c1539270e372fc99854bc6e4d94eaeff66 > -- > An old man doll... just what I always wanted! - Clara