From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.9 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D1859C49EA3 for ; Fri, 18 Jun 2021 08:31:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B2AAC613BA for ; Fri, 18 Jun 2021 08:31:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233749AbhFRIdd (ORCPT ); Fri, 18 Jun 2021 04:33:33 -0400 Received: from mail.kernel.org ([198.145.29.99]:41750 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232038AbhFRIdd (ORCPT ); Fri, 18 Jun 2021 04:33:33 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 4F5C860FF0; Fri, 18 Jun 2021 08:31:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1624005084; bh=IlI2xoknvp6cj5Rqd8Uau9s9Kd6ZolRir32me078cFs=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=PIyln4rhWLixs0LTS7Bu13tEWBmArcje3C0Q9GU2Hl/4kYAZ+8gKQnXA0MlPaVoDW p4zawkMPjCt5QhuU3d1fjFoKAPJYJ8k43KS60RjuCpcGZZT8diWmrOt+7jTvWZdxGa dDrWh0bN0ZTXeA3YdzopcLfHGTbgk+y5u+9NKB3M= Date: Fri, 18 Jun 2021 10:31:21 +0200 From: Greg KH To: Paolo Bonzini Cc: Jing Zhang , KVM , KVMARM , LinuxMIPS , KVMPPC , LinuxS390 , Linuxkselftest , Marc Zyngier , James Morse , Julien Thierry , Suzuki K Poulose , Will Deacon , Huacai Chen , Aleksandar Markovic , Thomas Bogendoerfer , Paul Mackerras , Christian Borntraeger , Janosch Frank , David Hildenbrand , Cornelia Huck , Claudio Imbrenda , Sean Christopherson , Vitaly Kuznetsov , Jim Mattson , Peter Shier , Oliver Upton , David Rientjes , Emanuele Giuseppe Esposito , David Matlack , Ricardo Koller , Krish Sadhukhan , Fuad Tabba Subject: Re: [PATCH v11 5/7] KVM: stats: Add documentation for binary statistics interface Message-ID: References: <20210618044819.3690166-1-jingzhangos@google.com> <20210618044819.3690166-6-jingzhangos@google.com> <0036c55a-72d6-7b5c-a6fd-3a285476e522@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <0036c55a-72d6-7b5c-a6fd-3a285476e522@redhat.com> Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org On Fri, Jun 18, 2021 at 10:26:59AM +0200, Paolo Bonzini wrote: > On 18/06/21 09:02, Greg KH wrote: > > > + struct kvm_stats_desc { > > > + __u32 flags; > > > + __s16 exponent; > > > + __u16 size; > > > + __u32 offset; > > > + __u32 unused; > > > + char name[]; > > > + }; > > As I mention in another patch, this should be sucked in directly from > > the .h file in kerneldoc format, so that everything stays in sync. I > > bet almost this whole file can be put into the .h file, look at how drm > > and v4l2 does this in a way that you only have to write the above one > > time, not try to keep it in sync in two different places. > > V4L's userspace-api/media/v4l is absurdly good and I'd say it's by far the > best documentation of any Linux subsystem, but it's all handwritten just > like in KVM. In fact, grepping for kernel-doc directives in Documentation/ > gives no hits for the V4L uAPI documentation. > > DRM has great kernel documentation, but quality-wise the KVM userland > documentation is on a completely different level compared to DRM; just > compare https://www.kernel.org/doc/html/latest/virt/kvm/api.html to > https://www.kernel.org/doc/html/latest/gpu/drm-uapi.html. The latter is not > about how to use the DRM interfaces from userspace, it's about how to > implement the userspace interfaces. It is full of kernel struct definitions > that should have no place in a uAPI manual, and does not include > documentation for almost anything in include/uapi/drm/drm.h Ok, it's your maintenance burden, not mine, I was just suggesting a way to make it easier :) I'll not complain about this anymore... thanks, greg k-h