Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 9 Aug 2022 06:01:53 -0400
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     Thomas Zimmermann <tzimmermann@suse.de>,
        Jonathan Corbet <corbet@lwn.net>,
        David Airlie <airlied@linux.ie>,
        <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        <linux-doc@vger.kernel.org>, Maxime Ripard <mripard@kernel.org>,
        <intel-gfx@lists.freedesktop.org>
Subject: Re: [Intel-gfx] [PATCH v2 30/39] docs: gpu: i915.rst: gt: add more
 kernel-doc markups
Message-ID: <YvIwkaYRbrd5+vtj@intel.com>
References: <cover.1657699522.git.mchehab@kernel.org>
 <d7d1f6d6516eb3a82041af1d5f40c2f550de40db.1657699522.git.mchehab@kernel.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <d7d1f6d6516eb3a82041af1d5f40c2f550de40db.1657699522.git.mchehab@kernel.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?DQIxFqe1lvu/S5Qk7AYIWYpeoSMZzl7aF8ykaWqQZZfITLVAgoWMHA1cdR4+?=
 =?us-ascii?Q?3k7whFd75L+8+tnaFewOokp1qSTXB32TPn/KoXBbpSxM/4gDEgEjg9jiJf1a?=
 =?us-ascii?Q?Z1H0U3LEMMmiVrDHj2HMyktxxJybe9zdMGKib54lCYKdGog+FOXGmgZWkzTf?=
 =?us-ascii?Q?vFJLYff6K9283rBiiwcN4y0n9cTdZrOASMnNDDqjs4dmtfkkcL+0jSFyuWro?=
 =?us-ascii?Q?LIX7lloTLI5yZluvpajoYwalwUjTaNrvsYKVsMBoi7w/NUj6/KQlaOTuVRaE?=
 =?us-ascii?Q?+iMnLSmjxWRbLQMZRcZvQwJPs9TQuYR+xfluf1c1Z4qa38qMnpdpGjfUev3h?=
 =?us-ascii?Q?HFMC+b2XaM1emm/tK7gDGzz2SovT2LZyusuJg244hN4I4qerpHaE+jsh5mkI?=
 =?us-ascii?Q?rguM8Ku7vtq7a6DlOioSmpQ35xAWoGFUcaTDGFV9gOcRWjbAPfDC26fPbNst?=
 =?us-ascii?Q?YN5Nc4WVTkOnulXYC1fsY6YIaQmiIGjhQMM1H/pNyoowhqPmvv/E2pFw5KzK?=
 =?us-ascii?Q?ARHm3Dwd2zXo0WvOQx/PToz+Aleo4ZEv++78LOmlsbFXtBGH6VsODBWqCkrQ?=
 =?us-ascii?Q?vrQFuU2VyhlwIF7hIZz4bzfUjOWQ2os6OV1BIbc8uFmz47g0QKSChKZ3+/xU?=
 =?us-ascii?Q?jPNM1fS7FwJGK4Opdt6TCvB9q8fhA6V52XfmjbpybJL2yUflazYF5opDbCgC?=
 =?us-ascii?Q?MtCsUgq/YzyHrQU/FSZa/viP+qPVi16u4aNIAn+UYbzMuT8pVPaZW35UxdHB?=
 =?us-ascii?Q?oOoRZzdle9vA6g0wE+cHSSvzLafMCeQh7IWc2lbjpPIEY9Y+j7XNd7WZ1/p9?=
 =?us-ascii?Q?pxvMm1jmLgAc4kvxVosxQU0K0EftAo+z+z5LFMsPiTFiVjSHNgN6SoxXi8tX?=
 =?us-ascii?Q?2sLT04TqqbnwqHHL2ANiUgzBtix4SPyZpGbHTXgVV6GQ9JA+hyfF+xytycTl?=
 =?us-ascii?Q?YP3v3XRXQ074KLFnf/WaUIwxwXp2NAydydYGHDO1mCkhHvDzzu3w6M16GJHw?=
 =?us-ascii?Q?A3WtjrfyBfwpRPH+m1+OcVb767HKmpJ1i0jsJsVMNOKg3uLJKuf8KPoW0EmO?=
 =?us-ascii?Q?PHpZVCuZpSXXemoqUKhy22qOE82MndO6+vauS25E987BvTFj0oSQy4BZyGcW?=
 =?us-ascii?Q?TbIhBYzYPvLZreER5/C7HSJUyXvTW8QSSRvZpXDQuksf1dPeatNBhHLcYLW6?=
 =?us-ascii?Q?/TUM5/6huA3ggSaTYk/sUbY/se7O8oSUzNzSIKOrq5FhP6cLJLujLr77aFiK?=
 =?us-ascii?Q?GougYGBf1IxP8rFRgzQEhXH28f9HYMdD433K5cC3dR6YqsRe9dvWpeShQ/Tf?=
 =?us-ascii?Q?iEGW+kKn1eKKwgbAQ/tRk7Pimr4MT/uqjYl/RgSdkHBrjRxBIRN9f7YtlkWZ?=
 =?us-ascii?Q?5DxYyISbBeLzKfXLELt/TM9nh5/kxCA3qvq8jVKZa4rD2Eby3Q2E0GPdy9+H?=
 =?us-ascii?Q?5577QNIpVSzoQJg+WBtVNS4HOSht36Q5z/EReQBDgyvZSpGOM6yfSAmcuJIy?=
 =?us-ascii?Q?5N5WulZNH2kiqtH/qeDMTh8bUC16m5Msy21HOw7u1GlfIgRFX/LVOMlzr1lv?=
 =?us-ascii?Q?ar80j1zZH3k3Gnxg/+euQ5dYVtmXLcZGqKoD6UeOzAeuTuF6ewcKjx51sUhH?=
 =?us-ascii?Q?Qw=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 5c756bad-71bf-4918-ffd7-08da79ee31fe
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Aug 2022 10:01:57.7612
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: SLK57UhZZt75wtSldnT4Acu+hD34pcBoWTyMboeCHhZxAMYcZ1SxnFKucNzVF+E9ublVYpJHETbteymEdh2v6w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB3514
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-5.0 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,
        SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Jul 13, 2022 at 09:12:18AM +0100, Mauro Carvalho Chehab wrote:
> There are several documented GT kAPI that aren't currently part
> of the docs. Add them, as this allows identifying issues with
> badly-formatted tags.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> 
> 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 | 43 +++++++++++++++++++++++++++++++++++++-
>  1 file changed, 42 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 2ad7941a79f2..afd8c0e3c689 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -149,7 +149,6 @@ Misc display functions
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/skl_scaler.c
>  
> -
>  Plane Configuration
>  -------------------
>  
> @@ -308,6 +307,48 @@ Multicast/Replicated (MCR) Registers
>  .. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gt_mcr.c
>     :internal:
>  
> +GT engine
> +---------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_engine_types.h
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_engine_cs.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_engine_pm.c
> +
> +GT context
> +----------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_context.h

why does the context deserves a separated section and the
many others below no?

> +
> +Graphics Translation Tables
> +---------------------------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_ggtt.c
> +
> +Other GT functionality
> +----------------------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gsc.h
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gtt.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gtt.h

Why aren't these gtt ones in the above block? why only
having the global gtt there?

> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_migrate.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_mocs.h
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_rc6.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_reset.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_rps_types.h
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_rps.c
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_sseu.c
> +
>  Memory Management and Command Submission
>  ========================================
>  
> -- 
> 2.36.1
>