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 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id DDBDBECAAA1 for ; Tue, 6 Sep 2022 19:53:05 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 0E37010EA65; Tue, 6 Sep 2022 19:52:46 +0000 (UTC) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by gabe.freedesktop.org (Postfix) with ESMTPS id 78C9D10EA69; Tue, 6 Sep 2022 19:52:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1662493959; x=1694029959; h=date:from:to:cc:subject:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=ogqkU6hwz+5RMxgjJdnuLelA2xSDzawITgx7hiHuXjg=; b=RQgOwPzjdnGSCmJQPgIdKwcsPPIw+uuagWHdV0FNUSEcVYFYbnKLg4If am02gItZ+5Gg3hNFuc+050YNflzkTWEWGLM/tpZWuXkl0A7S6fTLRDbXr U5vPHEbsmhDWF84NMw93vQzaW/2+7UNpurmjYgGRM+638HQVQSuk6YK6/ C75bYwHuk/hGLFLwVSbrrdWw5QKsvzT36OaGZKWuVK9tVDhY5uaEMvP9q a2pTdiV3V1Op/ToSWYgaUhXT0XT+GsN6gMKgHxC/3RBp3f2NsnuI5MZSR GrMk+5RHA0h1X15RTjT150O1PBoAaEwkzeWgYAXZfOAAZVQyvVbTF3m/f A==; X-IronPort-AV: E=McAfee;i="6500,9779,10462"; a="322869863" X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="322869863" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Sep 2022 12:52:38 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,294,1654585200"; d="scan'208";a="675842746" Received: from linux.intel.com ([10.54.29.200]) by fmsmga008.fm.intel.com with ESMTP; 06 Sep 2022 12:52:38 -0700 Received: from maurocar-mobl2 (maurocar-mobl2.ger.corp.intel.com [10.252.44.186]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by linux.intel.com (Postfix) with ESMTPS id 14A6F580890; Tue, 6 Sep 2022 12:52:35 -0700 (PDT) Date: Tue, 6 Sep 2022 21:43:30 +0200 From: Mauro Carvalho Chehab To: Rodrigo Vivi Subject: Re: [Intel-gfx] [PATCH v2 35/39] docs: gpu: i915.rst: add the remaining kernel-doc markup files Message-ID: <20220906214323.3d3a0db4@maurocar-mobl2> In-Reply-To: References: <5630ff7f2d5a99fc78b4fc2fa7e63649d23f226c.1657699522.git.mchehab@kernel.org> X-Mailer: Claws Mail 4.1.0 (GTK 3.24.34; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jonathan Corbet , David Airlie , intel-gfx@lists.freedesktop.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Thomas Zimmermann , Mauro Carvalho Chehab Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On Tue, 9 Aug 2022 06:20:57 -0400 Rodrigo Vivi wrote: > On Wed, Jul 13, 2022 at 09:12:23AM +0100, Mauro Carvalho Chehab wrote: > > There are other files with kernel-doc markups: > > > > $ git grep -l "/\*\*" $(git ls-files|grep drivers/gpu/drm/i915/) >kernel-doc-files > > $ for i in $(cat kernel-doc-files); do if [ "$(git grep $i Documentation/)" == "" ]; then echo "$i"; fi; done >aaa > > > > Add them to i915.rst as well. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > > See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/ > > > > Documentation/gpu/i915.rst | 87 ++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 87 insertions(+) > > > > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst > > index 974754586be8..6bb50edc6d79 100644 > > --- a/Documentation/gpu/i915.rst > > +++ b/Documentation/gpu/i915.rst > > @@ -13,6 +13,11 @@ Core Driver Infrastructure > > This section covers core driver infrastructure used by both the display > > and the GEM parts of the driver. > > > > +Core driver > > +----------- > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_driver.c > > + > > Runtime Power Management > > ------------------------ > > > > @@ -29,6 +34,10 @@ Runtime Power Management > > > > .. kernel-doc:: drivers/gpu/drm/i915/intel_pm.c > > > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_wakeref.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_active.h > > not sure if this belongs to this group... > > > + > > Interrupt Handling > > ------------------ > > > > @@ -44,6 +53,28 @@ Interrupt Handling > > .. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c > > :functions: intel_runtime_pm_enable_interrupts > > > > +Error handling > > +-------------- > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_gpu_error.c > > not sure if this gt hang stuff deserves a separated section > alone and if the name is the best one.... > > > + > > +Memory Handling > > +--------------- > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_vma_resource.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_vma_resource.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_vma.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_vma.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_mm.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_memory_region.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_memcpy.c > > + > > Intel GVT-g Guest Support(vGPU) > > ^ missing space > > > ------------------------------- > > > > @@ -109,6 +140,54 @@ Workarounds > > .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_workarounds.c > > :doc: Hardware workarounds > > > > +32-bits compatible ioctl Logic > > +------------------------------ > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_ioc32.c > > + > > +Scatterlist handling > > +-------------------- > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_scatterlist.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_scatterlist.c > > + > > +i915 request > > +------------ > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_request.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_request.c > > + > > +Ancillary routines > > maybe simply have an "Others" section and put everything > that has only one item like the gpu hang one? OK! > > > +------------------ > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_deps.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_deps.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_device_info.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_params.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_sw_fence_work.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_syncmap.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_pcode.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_reg_defs.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.h > > + > > + > > +PXP > > Protected Xe Path (PXP) > > > > +--- > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_irq.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/pxp/intel_pxp_tee.c > > + > > Display Hardware Handling > > ========================= > > > > @@ -618,6 +697,12 @@ Protected Objects > > Table Manager (TTM) > > ------------------- > > > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_ttm_buddy_manager.h > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_ttm_buddy_manager.c > > + > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_region_ttm.c > > + > > .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_ttm.c > > > > .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_ttm.h > > @@ -627,6 +712,8 @@ Table Manager (TTM) > > Graphics Execution Manager (GEM) > > -------------------------------- > > > > +.. kernel-doc:: drivers/gpu/drm/i915/i915_gem.c > > + > > .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_create.c > > > > .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_domain.c > > in many cases I see only the .h or only the .c... why is that? > wouldn't be better already put both in all the cases? No. Adding kernel-doc files that doesn't contain any markups will produce warnings. We're working hard upstream to have a zero-warnings policy for documentation. Regards, Mauro