From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 580AA42B2C; Wed, 17 May 2023 18:57:10 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 29A1340EE1; Wed, 17 May 2023 18:57:10 +0200 (CEST) Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mails.dpdk.org (Postfix) with ESMTP id 4979F406B7 for <dev@dpdk.org>; Wed, 17 May 2023 18:57:08 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1684342628; x=1715878628; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=TlbQRT4nm1P+DO0SwUqT7F9PgBWVsqG058d+E9VSbxE=; b=POLIBcP0yvUkKdR7Pi+sgk/vsyvpfVSyizei26xNRQJSzjw9v15CLCXU 3B6dSuHZ8d6Qkz34BWMRhGMq2usmSCJRyvAnYRDKkccsn4DILwSpDfnv/ tPNKE1nZXhXwcwsYI0UhxoYixW5vklDdYFi3pFkcwuvLD0cPMx0kw74eb WJKscVW8f8ll4NpSkKhpIqELXJs80+VjsjG8NRomZOYQmcW0vvEGvccy9 AsabjL4MwQCpk1VsCktV06WWnq2v0wSQvd/iNqGXOsglw7lpkp2WHe01j uvGpQH6qgij192vjQroe9WbtOirqIDUfphQQSFKGX83RylUZc5+kiSV2E w==; X-IronPort-AV: E=McAfee;i="6600,9927,10713"; a="332183396" X-IronPort-AV: E=Sophos;i="5.99,282,1677571200"; d="scan'208";a="332183396" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 17 May 2023 09:57:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10713"; a="695950066" X-IronPort-AV: E=Sophos;i="5.99,282,1677571200"; d="scan'208";a="695950066" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by orsmga007.jf.intel.com with ESMTP; 17 May 2023 09:57:06 -0700 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx601.amr.corp.intel.com (10.18.126.81) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23; Wed, 17 May 2023 09:57:06 -0700 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23; Wed, 17 May 2023 09:57:06 -0700 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23 via Frontend Transport; Wed, 17 May 2023 09:57:06 -0700 Received: from NAM10-DM6-obe.outbound.protection.outlook.com (104.47.58.107) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.23; Wed, 17 May 2023 09:57:03 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=WCxbVhwgA2zyR1vfNdU3VPhwOt3EGMmkpCMriPGGC0IJm6DUZYtAc7nUQvRYcTIebACiFH7NuvEq0+RxiXM1opk0Bi/66KPGD0pSM9oMT5EEVZjnAvQ9Y2FNJGOHHUpDCa/yLcRM18CYNaRl4sWtmhC6qmWcOePt8wHBHXsodd8Ucc4kFAmjUi8J6uZAl0SamO/4POLVKx3LS60ntJZrRvhZr31hxGvI+0u5Y8hn9RIZeuEMRcZ3Ff5PrzoKsZGgwX7yLhKAPMpBjHrrA9ZPCdFaCYXMXzzN+7ycwtv0isMIePyiwRSgkg/4t5u4j2d+YzXkiPLXOEbvkx0oWvQZNw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=uCCtqOvsRGnXT4A/llpN/u4BnE1+Dzcjs8HtIxSUrvE=; b=eMKboX4W5sqHJU7xvHzhUZT0/fW2UKMPKjt8hGmngYBK63vkdezJJF7DTTOl0NllmOCU0G8+uH7dx15+iB93cU5h6tJCxIyL5uuSWQEEzMzwwCr7Z/txgeC2bz8udR35SCy/5Pq+zJjytKfwtHtksusKaa448P8WGJaxpN7C3dC1zFSv2GS/6x9t9qukfuHqI/JYuFZQ2qta1mr2UjjMNLH0qH3pcVv5c8md72ChWo7yugzx6HHfT0yUCkV7MKaDdSszOsbJ+UWP1rL5tHsSUxVXI6N/h3vUMG2s64g+X9hW5EgdhU8cS+DvOG9xrsoN8pIvwF46k3YpqXhe33gpQg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by SJ1PR11MB6153.namprd11.prod.outlook.com (2603:10b6:a03:488::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6387.30; Wed, 17 May 2023 16:57:00 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::b8f3:958:d2c5:2232]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::b8f3:958:d2c5:2232%7]) with mapi id 15.20.6411.017; Wed, 17 May 2023 16:56:59 +0000 Date: Wed, 17 May 2023 17:56:53 +0100 From: Bruce Richardson <bruce.richardson@intel.com> To: Juraj =?utf-8?Q?Linke=C5=A1?= <juraj.linkes@pantheon.tech> CC: <thomas@monjalon.net>, <Honnappa.Nagarahalli@arm.com>, <lijuan.tu@intel.com>, <wathsala.vithanage@arm.com>, <jspewock@iol.unh.edu>, <probb@iol.unh.edu>, <dev@dpdk.org> Subject: Re: [RFC PATCH v3 0/4] dts: add dts api docs Message-ID: <ZGUHVZHDrcKGzdkb@bricha3-MOBL.ger.corp.intel.com> References: <20230504123749.1417259-1-juraj.linkes@pantheon.tech> <20230511091408.236638-1-juraj.linkes@pantheon.tech> Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20230511091408.236638-1-juraj.linkes@pantheon.tech> X-ClientProxiedBy: LO4P265CA0276.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:37a::16) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|SJ1PR11MB6153:EE_ X-MS-Office365-Filtering-Correlation-Id: a10b3dc9-5a70-4425-ddbc-08db56f7bab9 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: +XRkV4HdZYM/KGR+YXnVO+3bCkCKIDoQSVK8+NC29Dcs1WlJ5hnJWG3wKlUYPlfMhiEnuS+CwnkQTdICJ37DcFFTPU74Y7CTRQW9dsqJs/o0M50aTkNxh5hvG33uvNqegqLLIZEf+ecw5PkqtYiCKr3FPULRrN89/pvoF/vdUiLYm2sgOE3tYQLoq04oreuNoW7qXlg9JcXNmqsbT56UB+Fhpk06XE7HXdDWDB/BjZFHdyf6Y3JS/Rn6b7lptpKMoEzQ1QgeULaczaoT4Zhw51SkcbF99TiRPB+ceY9E9bfd5U4/8aY2IbfqWUX7hu1TkUSn1ogH7GlPHG78RCbNs0JhcXQjN7D1tgrQhV629FjvPdRh2ZcF/yq9Uf7FDC3GbP1p894dqF7K5hHm3qsTaTLQ6bX7x40n9151Hp73L0q1p3zXDl5MPe4iXHQ1P/NOdPP7hCg3ICZaMuAICKskNw241MIH6d+XMCrjk3ffEBB+G0k5LSZmedY6naY9kW2c7qfgp+CaTU1j90FZY8L34htdsTe0KxFPSO7G8I/RQcU= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(396003)(346002)(39860400002)(136003)(376002)(366004)(451199021)(44832011)(2906002)(38100700002)(316002)(8936002)(5660300002)(8676002)(86362001)(6666004)(6512007)(478600001)(26005)(6506007)(186003)(6486002)(966005)(41300700001)(6916009)(82960400001)(4326008)(66476007)(66556008)(66946007); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UXh3M1BtMzlWSEFMVmJURU1vbzU2ZFZVdGY3VG4xOU1pbytNVUhHSmV5Yk9C?= =?utf-8?B?bXJOd05uMGpVTi9nbTc2VHhld0NBWVdQRnowRGloTDRJNnFBbXovdmsrdTht?= =?utf-8?B?d3ZlekFKcElSU0VmNXhNaHc4RlJmRW5YQk5LUDVhdklZL2JkcjlSazE4M2dI?= =?utf-8?B?MTVtNUo1WVlVZ21YM2svQkFpcFhMTzgvdFUvZVZIb3RoRjRHUGdVOGZacm1q?= =?utf-8?B?M1ljdWNEMzhHZEVMODlNaGVLWmVnSk1QekxnVEZOMDBWVUVaWUN2cld0cmpr?= =?utf-8?B?RGxOa1gyQjBNejdKUjlSeHBIeGJiK25vWm9qdlhWTVkvL1c0SCtMZlI2YVky?= =?utf-8?B?YTB4SUpBRGhFa0dqc3FuaDNVM1RqWmVhMjZZeHgxUTZXcFVDOGFub3duM1VQ?= =?utf-8?B?RVhJWHZhUURIUkwvZnkxeWIyaEtNRGoybG8wcjJ5MDhWRmJoZlc5UHYrUlBh?= =?utf-8?B?KytyNnZtNzBrMkhqRDUvOE1rWkpNUGdBRkx2czVjVnN6SHNhbTRDSWNqR3Yv?= =?utf-8?B?dXZDVFp4VzQzRUpqcVBQcHpQR01maDJJSW1rc1RvVmtqWVhVSkNramxuSmZT?= =?utf-8?B?MFhqQm5ZL2ZraWRYT1paL0tZdnprWHhlb3hMSWdjNDN2YXoyeVA2TXh0TWEz?= =?utf-8?B?bklWTCtpaGVkVnhnMnNJMkMzN0xvUU9KZG83WVRqaHNPcUpXem9KNnZ3VVFJ?= =?utf-8?B?TDlqSzFYV25EOGtVV0g0alNlRGwzOVVoQXo0V0pzZnVZY2pmOThpdEF1YU1z?= =?utf-8?B?YnNtK095K0JDR0syY1YwM251cnB4UitVN2VPQVhodXY4YndxZzI5clA3Njhn?= =?utf-8?B?K3hRSU0rbjlTcFVKaks3U3BKMHZSNlErUWlRRTRoNHlEalRJS2pBN2hDb3Vm?= =?utf-8?B?YTVoekpYZkFEOUpSbFBZc3A5TVpacDdTTklOQzhQSVBWMWo4MDdNYXo2S1U2?= =?utf-8?B?T05TYURtQWFRMkFNd0RsK2VBeSthUFVQeUhmdXRlRnh2Y0dlMEl1bWx6REVW?= =?utf-8?B?MmdZTWlQVVpmZEVLeGxnNFZQeUxoc3ozSUVrWWl2LzdRRmFPby9pemlRMnR2?= =?utf-8?B?Yi9FUkJoc254eEJENjhGNWFVdFJ4ekxDMjNReDA2Z2cwMURtMUl4Q2JRdkxL?= =?utf-8?B?QXZWSUxEQnB6aElTa252cnFicU1PWnpSRm1GMFM2NDdGT0JvaUtBRXllVzZl?= =?utf-8?B?dUhRd1g2dkFiNzFqWXpvUW9VbG5MQmc4U1J3cTVQYmtHa3l5S1l2U21xZmtN?= =?utf-8?B?eDAwNkV4M1R0Mkl1MkRPeTBXK1EwZzNZNUQvV05VMEhRWmVWWHU3eWlaYVlq?= =?utf-8?B?bEp4cGdEMzJieUVScWNIcTB1WXFkSzhHandOWkRKMjV5eWd6S0JJRHROdWhm?= =?utf-8?B?dUhIT29qODJaUXNlQjFpU2hGT2M0SnQxaWNySXBoZktKOGRpdUkrQmdzK1RB?= =?utf-8?B?ZDloTzhMdTBGZWZzSHE0VmdnMDJDOU5VZWpITzJzNXhHU1VORGc0R3d6ZFlj?= =?utf-8?B?enRaL3RYTTZiYUFGeXc2cW40ejQrTkM3allCSmtZYSs3eHJRRWNmbDh6RDdz?= =?utf-8?B?N0hFaU81aElFa0RFaHdmSWpVOVR3WXFIdkpKOTB1bzZaWlFRaWxWVDR2TzBu?= =?utf-8?B?UFk0L2FJL0pUanVWRERwZ0huMUUwMnExcmFXd3ZZMUt2ejltUGw5b3hteDJS?= =?utf-8?B?RXRkNXdZekhOY0IzdmI1ZnRNUTFSOC9kbGdnUVlhYTJFK0xpcXl6aGVJeFBN?= =?utf-8?B?dG9sVkQ0N25NWlpkZGl4OEhhZzl1UkplY2dQbm5nQnRjQUMxdjl3ckVMN2lP?= =?utf-8?B?L0FFVjI5Q1lyaGppZ1RwempaSG1nQ3ZET3VNa210aEYzdUlmdjBLSER6S2RP?= =?utf-8?B?NWJnR2R6MXhSQ1l2dENtS2QxdFhQNSt0dExCdWhDYnNLcEZWSzlWK3owVW5y?= =?utf-8?B?SzBUUVZXbVZ2SHNjQ1p6WmRwbU9hRkN0SmJnc3JCV1BFU091eFNRR1htdXdX?= =?utf-8?B?andva2Y0N2Z3Q2hsVHZET0RUWHBGWW0rUUpITEFJc09pRFEwczRTakxXRlRE?= =?utf-8?B?cHhDdzlidE5IYVIwZWxYcGtlQjhidndCOUd5TVlVck1xTHhzYUY0NFVhUU80?= =?utf-8?B?bXkzbW8xQjdLMDg0UjJkZEtVRndHY0p4Sm9rQ212L3NjQXdBelBBSXJ1MTMw?= =?utf-8?B?QlE9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: a10b3dc9-5a70-4425-ddbc-08db56f7bab9 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 May 2023 16:56:59.8019 (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: MPpOV8FQnR4sT4Fuqr1chFbZFLDEgAswCimVbV359pJp+ZaXPgfotDNeLwfjDFPLH/yF5fDk+my77bOGeaSsj6BVMnjuwzHnOeq2uj3Lbpc= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ1PR11MB6153 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org On Thu, May 11, 2023 at 11:14:04AM +0200, Juraj Linkeš wrote: > Augment the meson build system with dts api generation. The api docs are > generated from Python docstrings in DTS using Sphinx. The format of > choice is the Google format [0]. > > The guides html sphinx configuration is used to preserve the same style. > > The build requires the same Python version and dependencies as DTS, > because Sphinx imports the Python modules. Dependencies are installed > using Poetry from the dts directory: > > poetry install --with docs > > After installing, enter the Poetry shell: > > poetry shell > > And then run the build: > ninja -C <meson_build_dir> dts/doc > > There's only one properly documented module that serves as a > demonstration of the style - framework.testbed_model.node. When we agree > on the docstring format, all docstrings will be reformatted. > > [0] https://google.github.io/styleguide/pyguide.html#s3.8.4-comments-in-classes > > Juraj Linkeš (4): > dts: code adjustments for sphinx > dts: add doc generation dependencies > dts: add doc generation > dts: format docstrigs to google format > Given that building the DTS docs requires a special set of commands to set things up and then to run the build through poetry, I think you should just drop the option in meson_options.txt. I think it's better if building the DTS docs is the steps that out outline here, and we don't try and integrate it into the main DPDK build. With that change: Series-acked-by: Bruce Richardson <bruce.richardson@intel.com>