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 916BFCCD183 for ; Thu, 9 Oct 2025 20:48:32 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 4519410E20D; Thu, 9 Oct 2025 20:48:32 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="SlXBNn0l"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.10]) by gabe.freedesktop.org (Postfix) with ESMTPS id E52C710E20D for ; Thu, 9 Oct 2025 20:48:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1760042911; x=1791578911; h=date:message-id:from:to:subject:in-reply-to:references: mime-version; bh=iLKpOVEYZnZpdIaAf+uuECnZ1QJPSZKXBrEYEGRPiFI=; b=SlXBNn0l2xtzRSDAJJyahFzFrxXdJVTgP3HnKiSINoasn9OnnpU4ZuNt aKm9EPN/c5KGd/fbENLU+7aI2Srj6wO8g7CNVZHndna8juBHgn0yrLtd6 njs30bCUaOKK6ZOFfn48PDgIQVjFWa4KF6VV/GpDstUbyMXq5Or/jMa+H leA5My76VUgj+402hHml8SJDabUXcu/PrjekY4/WlRf4JgUwL6IdYcl9v bc/ZqGkVOZHvkOf0WuK6OOZpxWGefQnyK+kvYG0yTeuwEwtKqm7ktUqpc ewRz/sBArdTpWiN1fFGIo3CyT5/XxpYTzFBk9j0yRBG+ecQ7wliesiiZ7 Q==; X-CSE-ConnectionGUID: D1QkyGIkSTa8bb3TYpVLhA== X-CSE-MsgGUID: d/bL6gu3Q4OMV1ferEAqFQ== X-IronPort-AV: E=McAfee;i="6800,10657,11577"; a="79706683" X-IronPort-AV: E=Sophos;i="6.19,217,1754982000"; d="scan'208";a="79706683" Received: from orviesa002.jf.intel.com ([10.64.159.142]) by orvoesa102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Oct 2025 13:48:31 -0700 X-CSE-ConnectionGUID: i0iBgRR+SWy0UCuVO0ytvA== X-CSE-MsgGUID: OObb7BihTuqUSeP4scorZQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.19,217,1754982000"; d="scan'208";a="211455859" Received: from unknown (HELO adixit-MOBL3.intel.com) ([10.241.243.133]) by orviesa002-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Oct 2025 13:48:30 -0700 Date: Thu, 09 Oct 2025 13:48:29 -0700 Message-ID: <87cy6vx0ma.wl-ashutosh.dixit@intel.com> From: "Dixit, Ashutosh" To: Kamil Konieczny , Jani Nikula , "Dixit, Ashutosh" , Pawel Sikora , igt-dev@lists.freedesktop.org, Petri Latvala , Arkadiusz Hiler , Juha-Pekka Heikkila , Bhanuprakash Modem , Karthik B S Subject: Re: [PATCH i-g-t v10 0/5] Establish MkDocs Documentation Framework for IGT GPU Tools In-Reply-To: <20251009150805.6mt2bqzdogaezq4t@kamilkon-DESK.igk.intel.com> References: <20250909112741.185825-1-pawel.sikora@intel.com> <865f580c0697ef1df5c364841a561475d46aa9ba@intel.com> <87ldlme8oc.wl-ashutosh.dixit@intel.com> <4bf159d87af719a5c820f32e5430ea252ff06e3a@intel.com> <20251009150805.6mt2bqzdogaezq4t@kamilkon-DESK.igk.intel.com> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue) FLIM-LB/1.14.9 (=?ISO-8859-4?Q?Goj=F2?=) APEL-LB/10.8 EasyPG/1.0.0 Emacs/30.2 (x86_64-pc-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue") Content-Type: text/plain; charset=US-ASCII X-BeenThere: igt-dev@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development mailing list for IGT GPU Tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" On Thu, 09 Oct 2025 08:08:05 -0700, Kamil Konieczny wrote: > > Hi Jani, > On 2025-10-08 at 11:07:00 +0300, Jani Nikula wrote: > > On Tue, 07 Oct 2025, "Dixit, Ashutosh" wrote: > > > On Wed, 10 Sep 2025 01:26:23 -0700, Jani Nikula wrote: > > >> > > >> On Tue, 09 Sep 2025, Pawel Sikora wrote: > > >> > Dear Maintainers, > > >> > > > >> > I am submitting a series of patches to introduce a comprehensive > > >> > documentation framework for the IGT GPU Tools project using MkDocs. > > >> > > >> There's been a lot of iterations in fairly quick succession, and I have > > >> yet to see any comment from maintainers wrt my feedback [1]. > > >> > > >> I'd rather see a clear statement "yeah let's go with MkDocs" than just > > >> having this gradually happen without a conscious decision. > > > > > > I will take a slightly different approach to this. I think Jani has a valid > > > point and if this effort were starting today, I'd say go with > > > sphinx/rst. But as far as I see, this series has required significant > > > effort to get to this point and is almost ready to merge. > > > > I don't think it had taken a significant effort by the time I first > > brought this up, and I kind of expected to get feedback from the > > maintainers *before* a lot more effort had been put into it. > > > > And now it looks like what I feared, it just gradually happened and > > nobody stood up and made a decision. > > > > > > BR, > > Jani. > > > > Imho this is not touching documentation for API, which uses gtkdoc, > only general info spreaded in few IGT text files, so using mkdoc is > fine by me. Also, there are converters in both ways to/from rst and > mkdocs, if anyone in future wants to do it. This also touches only > one link on gitlab: https://drm.pages.freedesktop.org/igt-gpu-tools > and also make our IGT page more attractive and more accesible for > colorblind people. > Moving from mkdoc to sphinx also seems possible with more html/ccs > effort needed. > > If anything, we could think of replacing gtkdoc with sphinx. Yes, please, we should investigate this if possible. > In conclusion, lets stay with mkdocs for now. Overall, we should have given more attention to the direction we should take when starting on this, but given where we are now, I agree we should merge this and then ponder next steps. So this is series is: Acked-by: Ashutosh Dixit Thanks. -- Ashutosh > > > > > > > > I don't know how much time/effort it will take for a similar sphinx based > > > solution (Pawel would you know?), but given where we are, it seems we > > > should just merge this (since this would provide some missing documentation > > > immediately). And then if we think we need a sphinx based solution and > > > someone can be found to do that, they can switch the documentation to the > > > sphinx based solution later. > > > > > > I want to elicit Pawel's feedback in particular, since he is the one doing > > > this work. > > > > > > Thanks. > > > -- > > > Ashutosh > > > > > > > > >> > > >> Cc: Everyone from MAINTAINERS. > > >> > > >> > > >> BR, > > >> Jani. > > >> > > >> > > >> [1] https://lore.kernel.org/r/3d83d59669d62f004a507a25510b21f9bd273410@intel.com > > >> > > >> > > >> -- > > >> Jani Nikula, Intel > > > > -- > > Jani Nikula, Intel