From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3859C42E9B; Mon, 17 Jul 2023 13:09:32 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2A16D42D3A; Mon, 17 Jul 2023 13:09:32 +0200 (CEST) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mails.dpdk.org (Postfix) with ESMTP id 7139240E25 for ; Mon, 17 Jul 2023 13:09:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1689592166; x=1721128166; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=B/b8aIqzqv0XyeS8G7iZasAdmR/D0LwMeIA6ubhBMFU=; b=I7iprKXrG4Tf4NWNd4+Jm7pgrCgblOSxkvQzEixu+1zNaonLSJPSPw5r cvapCk+7vN9WbCc6wNSIoAS94Sfgm7pvY5xd2+EkAJAXUJ0c3yVcGCmYB vjfO/HumQJV5on8CnQ4SOOYtjgTAxHNWCWOABuD6b6CoAUJMyh9y6heSF kstqnbC7U4/Bjd+RJ76xr/p1WuUUki2157pVVqxjxIQe1wc/RJ+RXPu6q uiM77yqMRK3EuX3ANHlIt4w0avlJJO6FWS444udLsP4Ai+b4fVM+x7a5F xeMPX7HduGDe31smId2pJhhAAOPuP+SSuSlAKJDbXAjNW4bTG8MWYeAfH A==; X-IronPort-AV: E=McAfee;i="6600,9927,10773"; a="345492624" X-IronPort-AV: E=Sophos;i="6.01,211,1684825200"; d="scan'208";a="345492624" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 17 Jul 2023 04:09:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10773"; a="813282272" X-IronPort-AV: E=Sophos;i="6.01,211,1684825200"; d="scan'208";a="813282272" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by FMSMGA003.fm.intel.com with ESMTP; 17 Jul 2023 04:09:24 -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.27; Mon, 17 Jul 2023 04:09:23 -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.27; Mon, 17 Jul 2023 04:09:23 -0700 Received: from FMSEDG603.ED.cps.intel.com (10.1.192.133) 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.27 via Frontend Transport; Mon, 17 Jul 2023 04:09:23 -0700 Received: from NAM04-BN8-obe.outbound.protection.outlook.com (104.47.74.48) by edgegateway.intel.com (192.55.55.68) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.27; Mon, 17 Jul 2023 04:09:22 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=D0Z67cs9GSbeJ0ILgsNgjI4mHgSyQHArpPDp1BPElxDPwhexVo+7K+oXfQ4J8lvQrn5wNG7Qu5DxPNxS/m2HHPnQURR9SXnRjJn84Hf64SbW823R6gCDRJSKl2HoajWqXlh3tjBaSry9iMB9tEcLkdadndBch5cdyP+9PYzlhVtcq1WdupmmgupNWlyTXmxRo5rL+S/suBiOqNwSXfazSUJrfj7H57BM/yox7ahd8ojSXumH2vGxdBMBeu58hjl3Jqa8giyxoTR+ZuEYSs8CJTuiXxolhMDO47R1tj74pi0L64NQiF0JmKVYwfl/mj78aBWnS6aSm00wh7fkyC9xMw== 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=DcDDsM6E83WCMxywa4nNJlyo6ljokFitPEWeXg4gT8Q=; b=QGee1UNcxNQFpslMSTPSHyS4mCJ8hyVnLgpxAcPcWZFU09qGTyH/H2NObkB0XRD06O5HQSsOfIpbKm5bOQwjfqWOrR/4qikTmc+12zLWePguh2Z0RfE0bJhaEze4LLEL2NGgmVwbaSUiWBml54WBzoqgoD/rQCRcHJOXDu7F40U48/J4GDAmSkyThUKetsrxVOaZCkrz9SUicqCvRCOp39PmxkunVZT9BKrfW2uY/Zm/FcFl2zfOvbWn/9M8Uc7hEEUVzgfEkEerReEJMOA/2QaEPhQSCNdXBFALvKm2L7R6PlYzRqFVjxmBRCtp+MadZmP5Mu+UBa+8EOXrtU4RdQ== 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 DM8PR11MB5685.namprd11.prod.outlook.com (2603:10b6:8:20::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6588.31; Mon, 17 Jul 2023 11:09:21 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::44fc:41c5:90da:642]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::44fc:41c5:90da:642%4]) with mapi id 15.20.6588.031; Mon, 17 Jul 2023 11:09:21 +0000 Date: Mon, 17 Jul 2023 12:09:14 +0100 From: Bruce Richardson To: David Marchand CC: , Subject: Re: [PATCH v2] doc: build manpages as well as html output Message-ID: References: <20230601153801.118616-1-bruce.richardson@intel.com> <20230606131230.70428-1-bruce.richardson@intel.com> Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-ClientProxiedBy: DB8PR06CA0006.eurprd06.prod.outlook.com (2603:10a6:10:100::19) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|DM8PR11MB5685:EE_ X-MS-Office365-Filtering-Correlation-Id: 56ff56c7-0bf1-40d1-ecfb-08db86b64505 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: cmn5L69XxGiFjAaag79NvBrL9SVjJn6tgKqncealDpWghREt3V6c+TDnMgGPWGSzUj4QVP0Tk/mtW7F/pTGhdENwbwtZbAmZkgY5ysauvO4mOXa+MopEWfpuqTQdlfGXIXBQPpYE3VhMkk0y4JeC8C1Mn5df5waLI+YOxKU4XedN2YkS7ahhtHYaGd42OVN+tOD0b+fk6d1bsHv7Q3Mv6w8BN32J1kMj042TG6mZSatwXF/jwYig6eg4pstnFkybvgCQ7g1fk5GMwaEg3YKmgdCF5rhbrG8BGKsVXw9PwWEx2D53Gu8AS8zwMq2SdMbGpmJyH6MraRyefWxfDCYMvmGcbJoGGM2J/2lYtlSYSN5kBjcDg2Tf9JAULOaKDpDvpS4Vkle1WNY3L42DL84stqIgn6O24VKtNQy6SK1bbA2pQnaci0g1KLo4Azlg5uvg1Tau5qqj6L9x8XRrVD0N+TfeFfY1hFgiEcQXgGESJ4mO3fTSHxAJ73YZ9SqzGl/Q3/iwDyGMH/wxC8aGsASiv7WqjcTk30YS4rvyASJgN63YMsylwnNOYepmkoVTjjou 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)(366004)(346002)(39860400002)(396003)(136003)(376002)(451199021)(86362001)(2906002)(44832011)(6512007)(186003)(83380400001)(53546011)(6506007)(26005)(38100700002)(82960400001)(6486002)(6666004)(316002)(66946007)(66556008)(66476007)(6916009)(4326008)(41300700001)(478600001)(5660300002)(8936002)(8676002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?L21UWTRJbXRhM2ducGNXc1hOaFJsZ3pRcmlJbURQMTFmRUxWaFNWbENWODRJ?= =?utf-8?B?STNZS0lJV1BHOGxTczIzTW9aNjZUZ1ROOGNSTXB2VitZUGp4TjFsNWN6QU9Q?= =?utf-8?B?V1haU045Vmk5c0pEMUxoNUxUUGFmY0Z3S2ZKdlJWd01XODN0MWJTZU9uWndE?= =?utf-8?B?bVB0SDhmNE1KY0p2UmJjWk92dGZIT3hCMmFtYlhXZkl3emdUWEtBVk5ia0xn?= =?utf-8?B?Z2VOSkNDMk9ySDUzSVZza2cwRlcvV3RZRlBWSFU1WjZIOGtlZGlYMDBXUDlv?= =?utf-8?B?RGRyWG1oL2U3ejU0TTUrc1BVWWpBMTI2UEZTYUhydkYvSDE3ZUlSd084cmti?= =?utf-8?B?R3N5S3BwMFgzd1piZDFnTG83Rk4va09RRzFzSHluVDBPVWRqSVNoSkRUa0dR?= =?utf-8?B?S010NldHZ2JWeUNIYVBTb3BxUlhSUUp2bjJwdmFrT2V2VFU4c2ZJUzRTcEYv?= =?utf-8?B?M2ErN3hvUUtCTHgxYTgreWdOWnZXYjZvQ1JDb3dMOTZITW1wVUZsZkhqWmRU?= =?utf-8?B?VS9qMW9uUDY1SDU3VzFDUlVNZ0hvalJqT2NDSkF4Vk5VbVBDaHhxRi9IcWpy?= =?utf-8?B?cmxsK2JXVWJXNWs4UnNucEEwWkNMKzlYRkFmbnM5aGpSeGFuK2RhamtJYVNO?= =?utf-8?B?VFRGamlYYStjVklZMlNvTlR0NDdMNXp4V1lERFZuSTlkREFscFdLV0xCMXh6?= =?utf-8?B?QVFXZDNYSHNmWXZ5SWl5ZVNpNDdBRUUyTVR1cW1WYjd5bzRiWW43SzQ0Qy9W?= =?utf-8?B?bDh2UkdES0prYUxrYWc0azJYaUk4VFR6LzY5aEVXN2ErV1JDVWp5VThsK0xs?= =?utf-8?B?NVJzN2dBcG9QeVdFUzB3VlliTXdwbnVrT1BLMlZoRVlMblJhVWFHWk13c3Rk?= =?utf-8?B?TE44YVQyZm9UbTQzWHBYamRPWCt4YVJ0Z2plWDUwZU1Kd1lMeVZnYmU2TFky?= =?utf-8?B?aVByK20rQ01oV3RkZ3hGS1I1ZkFINi9rMXBKNVRlSmVTVEpNVzBsWXlLa2N6?= =?utf-8?B?elIwNTZqdVh1aHh5cDhtT1RKcys4Wm8zWldBQTBpL2ZYc2NacW1VWVhBenZq?= =?utf-8?B?TkNFbFJEdDJYUkd4QkhVUFlOaURhWEx4NWlUZkRlRTkzbjBBV3duQ0JqNVpw?= =?utf-8?B?ajNrdzQ0MUtUQmV1ZFN0ZE9pRVViT2lONWNOZktvTGh1R1p3WlkrSVBlSVNG?= =?utf-8?B?QUdsWm1iLzFFZHIwWWRZVkUvYmoxTmZYSWk2SEZ1bk1LWlg4UEk5Q0xqRWlp?= =?utf-8?B?Ri9VOVI4aHVoTkMvR3V2SUk1QTJqU1dCR0hQZ0UwRC9WN3NRSS9uY1ROdUZQ?= =?utf-8?B?WjQyWTFReEJBVi9qV1pqVE9kcWQvSlBCcGFCcktsM2ZZMDJXN2tNRFNMNzdl?= =?utf-8?B?a0RycFBqQmw1bS9nY0Z4U2RTRjR1Z1E2cFAyYlZydmdaNHFuMWFEeWlhZjZ3?= =?utf-8?B?YnhXaXBLb1BUYVpRaU0rMFVNVkZGNndxTE5GRnN2K0l2YmIrOUF4aGRPWGhp?= =?utf-8?B?VFgzZTFyYWVoVGQ0NWwxbFNPZnpYQ0pZU3ROenNnUVFRQ3BrVTF6Q0l6UnZG?= =?utf-8?B?R1h3ZDhCL0hYMEE5MXd4a2ZxeGp0VE02SEI0ejlHVHN4UWNReVNwa3J6Ny9U?= =?utf-8?B?NzM2TjYvUkowZE9LYkQxWDJ2V2N5WE5Pd0JBL2Z5eTFKbVlrRWVLLzdhL1RI?= =?utf-8?B?dk5rbmZjMjhvZGNYa0FlUmc3cGsxbUlKSnRjTW1nTHRmZk5nT0kzc2M1Yy9P?= =?utf-8?B?ZmNHSnFtNHhiRUNWUGxSd3FFeGZOWk1Fam5UdDJtNnRpSWdYMFJ2QktWcXJJ?= =?utf-8?B?NUtDdmFTd0tNQUc5Z3hFZDAwbEl4UUZlUjFRVStPOXlOTEZ5NXlWdDhPcXhI?= =?utf-8?B?a2U1S0FVZkZxUTA2a0hmZ1crbk9xN29ZZUJldWh0OFlwcjF6Zm00UVptTDVN?= =?utf-8?B?M0VXNXBBVVdkMzBVN3ZUYStORldodXJJbzJYdUlvUEhURGcwSUUxZW5MbkZX?= =?utf-8?B?clg5Z1ZFSVVyM1BYajBTTnlObHNTcDl6TTdJZnRPNWJIWm1kYXFaY2xYTVVI?= =?utf-8?B?emJYS09hbTJKbUlrM3krUmwzOUdBeCtKOWFVV1FURkNBRUFuZSt3UnBhM1Av?= =?utf-8?B?UWVxYnIwQlNoNjFsNVFBN1dxSlg4cjdPM2lEbXJUM21ZWm84U1JkaUlyMFJm?= =?utf-8?B?elE9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: 56ff56c7-0bf1-40d1-ecfb-08db86b64505 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jul 2023 11:09:20.5204 (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: 1gTJeMPngXcVngKDBhXiaiVP74m4uyYAYPEWLqtjPfR+0yHZoY6wgGEmimV6+NTheWe6a+FgY4JkPclIj191d10RPN6qEY1Moy3eoBGYRJ0= X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM8PR11MB5685 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Tue, Jul 04, 2023 at 10:21:22AM +0200, David Marchand wrote: > On Tue, Jun 6, 2023 at 3:13 PM Bruce Richardson > wrote: > > > > Doxygen can produce manpage output as well as html output for the DPDK > > APIs. However, we need to do this as a separate task as the manpage > > output needs to be placed in a different location post-install to the > > html output (/usr/local/share/man vs /usr/local/share/doc/). > > > > Changes required are: > > * Add configurable options for manpage output and html output to the > > doxygen config template. (Remove option for html output path as it's > > always "html") > > * Modify API meson.build file to configure two separate doxygen config > > files, for HTML and manpages respectively. > > * Change doxygen wrapper script to have separate output log files for > > the manpage and HTML jobs, to avoid conflicts > > * Add "custom_targets" to meson.build file to build the HTML pages and > > the manpages, with individual install locations for each. > > * Where supported by meson version, call "mandb" post-install to update > > the man database to ensure the new manpages can be found. > > > > Signed-off-by: Bruce Richardson > > Nice.. we should have done this sooner :-). > > Reviewed-by: David Marchand > > > There may be some polishing to do later. > Looking at the result for rte_eal_init, I see that the generated > manual starts with a reference to the rte_eal.h header with a path > relative to its location in the DPDK tree. > $ MANPATH=build-gcc/install/share/man man rte_eal_init | head -5 > lib/eal/include/rte_eal.h(3) > DPDK > > lib/eal/include/rte_eal.h(3) > > NAME > lib/eal/include/rte_eal.h > > At least, it is possible to ask for this header man with "man > rte_eal.h", but it is a bit confusing. > Is there something we can do on this side? > Not sure, not really familiar with how doxygen works generating manpages and the options supported, etc. etc. Mainly I just looked at the build-system side to support this, since I really missed having manpages for DPDK functions to quickly check parameter order. /Bruce