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 8F2D042FC8; Thu, 3 Aug 2023 18:43:45 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2A85940C35; Thu, 3 Aug 2023 18:43:45 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.65]) by mails.dpdk.org (Postfix) with ESMTP id 8F479406BA for ; Thu, 3 Aug 2023 18:43:42 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1691081022; x=1722617022; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=Ap2N7SQu4XNg8s2Yo08grWumlYS5uvSWsARSUSL2E/I=; b=hEO5W7bQ2JgpJiFfGmz53QH4GBn1bKvk3ks3tbbItEj7Axi/RSc/DYsR a4Tvxj/mKLdQN6xL6nKPj9PtD9TRGgZVB1gSjULhzpaxMLQDUMFeqc7w/ IjxKZjaZnbROq4Q34rjWC7Poa4gyqJ+6d5vtStjdmkTjZf+WT3VjBFmC1 JS1GjYRzgirtgp4FYK4jkKm1vni9EHZc2DeolWxLPfdzR5V91tkS9RT6h dTY17GCkEmksRLMzzu7w/55AtnZpqW4kOgZ6qCfbGG43iNqiNJ7vxg96r zW4qKrJQrqNRqghEtn8rDOyybzxNzGEWzGdYvN3ZJFs56ksPoH+ngEccg g==; X-IronPort-AV: E=McAfee;i="6600,9927,10791"; a="373577045" X-IronPort-AV: E=Sophos;i="6.01,252,1684825200"; d="scan'208";a="373577045" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Aug 2023 09:43:41 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.01,202,1684825200"; d="scan'208";a="872997588" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by fmsmga001.fm.intel.com with ESMTP; 03 Aug 2023 09:43:43 -0700 Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) 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; Thu, 3 Aug 2023 09:43:40 -0700 Received: from FMSEDG603.ED.cps.intel.com (10.1.192.133) by fmsmsx612.amr.corp.intel.com (10.18.126.92) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27 via Frontend Transport; Thu, 3 Aug 2023 09:43:40 -0700 Received: from NAM12-DM6-obe.outbound.protection.outlook.com (104.47.59.172) 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; Thu, 3 Aug 2023 09:43:40 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=EsYIeyJ8cusiy9ueZLNZUTMvkqdXXMQ6AwuLO24Vz67CR87n/hnTvQgMy9cZy1VsgGUJMlSutFmw381SIRrIS+sgSd0EolXKqQbLcVZw1WGJt4RYgi4p1Sg40Oy3SYi6JvGk6t6ffkLmcJouieKjC7iFC32V5WEBOveQFgOepJXV7UhK6AqlpTLyZWmwwWSAKh0rv3vO3ETliIbzu/EDReFmOA+2wPMoO8dJQ6+fL0o6MIQOaO/QFYGh53o6YYJxzO7YWnQi7uH+n3dm0icv2FDL1I8deFxV5pZ+2pZt0fYFWYBLjpdifv2xI7PrpxaHtQZskDaXuRzcTeC3HfZ0rA== 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=gvDmLSOUQ/NNs9j/2A2TU5vV5nrG+t9lg7z2Rq2J188=; b=gF1N/09w4FADO9h/uN6/ufB8JhZ1f7g7t5L3d9LC5SIigqMxtxnWZcUfU3pR1rgZ0RJ/iSFgbTPMnjJiZMV9xQBrVITLyyRpMmBI7dgpOO9zTwjtuVEFkbP9NMfEsENSFwfFt6sfJ1WcNgImPtHBAi4vhykDXAjRBPTdqwKJE74fks8O6JDmmOrax5qVsL254HTIiCTLT0lEW+S9r4bC7mydf3oUzWlhzCtAk3R3AJ+FzZ1mwRyd8fgCCdxMVM2uTRH+ejCYSmP7kAdI3HnNpX1igxqJHxUkXAnZ61IR/9RICfdRg1iGfoIYOgTQs5Gq75MgVSzkQ3fXjzBohr+jCQ== 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 DS0PR11MB7768.namprd11.prod.outlook.com (2603:10b6:8:138::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6631.47; Thu, 3 Aug 2023 16:43:39 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::9802:65f0:c441:780f]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::9802:65f0:c441:780f%7]) with mapi id 15.20.6631.046; Thu, 3 Aug 2023 16:43:39 +0000 Date: Thu, 3 Aug 2023 17:43:33 +0100 From: Bruce Richardson To: David Marchand CC: Thomas Monjalon , , 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: DB7PR03CA0104.eurprd03.prod.outlook.com (2603:10a6:10:72::45) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|DS0PR11MB7768:EE_ X-MS-Office365-Filtering-Correlation-Id: b3ba0780-73d3-4029-e15a-08db9440c9d2 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: fMWrQq/QbQhsNDwB5n7yXJ4RfSLQvoU6eDMP9VVIIMs/agLe1kcuMX6ektoPGr1za8WGWUHCTOAfnRk25wFqoXvMu2ZUvpVGySKinQaE2fcGr6P7zoK9v8zqKe1WP3b3/mqRWgW6I+v9uwPXkgpj0zuBH2icesDE3bQ/0KVjvyg3MwAbhE6sE4c2QeLmKom3AnCHklk08jS1+JYwhifBnMyHgkdz+TrGEy6gRGTDLHb8yTY6Pbq0jN++C4cH14NZtXJoaO+J/hCQNpd/nITSalwFQcbZMj+uGbpef5wvRdstTy8+P9TsrlKgX0XWt/KkwUnVC+QUwBoXSYRNhoixs/ZsPInIqjC8wl6+ahHfzR0xczJZn73xSzFJaE+0hM5HGZkpwPW3lIWn+7lLXm+I6RSpJY7QtiCRW/SQONYZHGGi0CpNPmlk/AtTc5npA8sx+yrTQO8R2NEfmw71IVep4kc1LftrA0lPttkpEqby9hpAvxpQ5YMfaRHkH907xQkbAArUmjxu+8bBdvIdp6RcLF6Qv2z25I5Q+ev/zuYLsLkRaWYwn+m03LqSyeQlp5T5 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)(39860400002)(136003)(346002)(396003)(366004)(376002)(451199021)(53546011)(6506007)(83380400001)(186003)(26005)(8676002)(316002)(66556008)(2906002)(4326008)(66946007)(5660300002)(6916009)(66476007)(41300700001)(44832011)(8936002)(6486002)(6666004)(6512007)(478600001)(38100700002)(82960400001)(86362001); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?cVZJTUw5T2twSkpnRjJ2ZDFBS24zSFE3S1ljc3FyNGdsSWR2bFZ5TFQ2MW5O?= =?utf-8?B?dkVKdHpBbDU2enBVQWpNUjQ4aG5pWUJOZkJQMzVLUWRnZG5UcXAxOE1jSndC?= =?utf-8?B?MDlpVENOejFkczVXdWFzWi9ZaDI1QlU3REwrS01EcDhhL1lTejFrdHZxVjlz?= =?utf-8?B?WStqNnJ6dlo5VUI0WHVWdHZ4SUUzK3NTbXR1NHg3TCt6RW4wR3ErekhHUkIw?= =?utf-8?B?a0VQN1QrNEFLZjJwdC9DM2xXajJ0Q09WRjBBalAyTG5FUUNwUkRPNHNPMXd3?= =?utf-8?B?a3AvNDVKRDBneXZzOVhrYnlXUXIycEliM09qWnlwMERtRldOeVNkc1ljdk0z?= =?utf-8?B?VGM5aDhSUm42UnlQdVRmOUV1TTBXcEUycUZkSVBJaDlZL0RnVk54aUQyRDJK?= =?utf-8?B?VUY3Yll5Uk1vOFVEdW5iaEVKWG5vMUJDZVR2QjRmNFBMYWs4TFczTVdsa3FK?= =?utf-8?B?cXVXVW9Fa0FWQjRCMm4xV2kvSjIrYStxVG9ad1RjUWcxV3JrMEVzVTEwNG9N?= =?utf-8?B?WktRcWtxOS9QeFkyVExzbTRzbU9ZZ2pTQkozVC9ybi9aME1LU05FUUZ4OXQz?= =?utf-8?B?L3RhN0dFRXFjV053ZTFKd3RGRU9hcGdGckFPQmx2ZEdUQnQvU2haeEJFL2xH?= =?utf-8?B?VzU4VVFFRkZTbXM5SDFjVEtsVmN1aTVkVW5MKy9HQW1Fb2xTb1FmSEprRERs?= =?utf-8?B?NE92OWR1T2d6ZnpDYktlN3R2SnBBODVIaGZEb05zZzhwNDcvdHhCUVYySTd4?= =?utf-8?B?aHV6dHlqSVIvNWowejRneC9DblRybWlBV0N2VDRkK2xrRXU0TlJ2aHN5Z0Z6?= =?utf-8?B?b1M0czkyanVXUWU3cFFCdE9XZGh0UUIvdTVxMER0eDBVM0wxdHo3ajE1aTF4?= =?utf-8?B?OUxQZERpMEEyVVBpc2hqck45TkdBUC9RZTNxMUxTYkgyYWVsSVkzRFFCaVZo?= =?utf-8?B?dzJSaWpJQWMwdHdhUFYramNXdmFsZzNlSHRVS3h1Uk9nWFVFU3R4OU1TS0Nq?= =?utf-8?B?eTdVK3JMUUVZY1FuQTA3ZTlvVGRYVGU3RkNUanhsYVVNQWNQK3pkL3I4dEVY?= =?utf-8?B?Qms5YXVQU200c3VRSlJiTHdlV2xpK3JNNHIyUFZhdmxvbGFvTXVObWd5TDgz?= =?utf-8?B?N1ZKbUhsNFpBVWtkS0JQOSsyOUZCNDBXU21mUVE3QXpNY1hPdkxJRm5oRXFQ?= =?utf-8?B?NWpoRm5HSkdOZStDcHI5Z1BSWVl5WG5tdkVNV2VBSEtWNWZKUndQN3FnOHBu?= =?utf-8?B?OVFPRTZHV24vclZLckd5TERoMlJEZVlWM3VRSGRrWG44RFRLNi9iNEc3QmIv?= =?utf-8?B?eVlvVGxBZ0ZOYW5aL2s5ekE0UVhYVWlvMXVuVGx4Y2pEYytNNWJ5enRTQTBO?= =?utf-8?B?VGxnL3hKMlBoUWZqWFJLYXJ4RCttWUZEWTNNREE4djMxUkpEL2xLRi9weEFl?= =?utf-8?B?ckNGSjhDQ3ZxZENjcFp3Qm9MQ3FzWHY0b2EybEhYdW1qbTAzMExpSVViOFdv?= =?utf-8?B?bGY3TGtGMTJQVVl2UkR4RXcxWjFjbVFYOEd1LzIzdzFvTmZaYUtGMG9sempx?= =?utf-8?B?Ykd4Q0dGZDE4Ukl4VXR1cFJ6NWJyZmt0ZEo0YUtDYk9vT1IyZ2NSeWFtaytj?= =?utf-8?B?RVF5Y29QeVRhRzc5amtjMG8zNUE2aDN2SW9KSytpNnh0SXdsRzFMaSsxRllO?= =?utf-8?B?RXI3Z05JUXlPV3ZqeS9iTHRzV1JXUitqRUNsVitYY0pGTTl5bXhTOXE5UERs?= =?utf-8?B?NXFMcUo1NS9URmpLM2M1cTRqRmwvb3lRa05Xa2tWMVBSazVhU3RLWnVaaEJi?= =?utf-8?B?S0xHalZCREQyR3NTMjloZTM1aWYrVWE5dTRaMWpLc3Z1dTRXbTIzUmp0RG9P?= =?utf-8?B?Z1dYajY5WXozT3RVSGZJRmFkRkJDQ2hXMXBjbFBHK0d3ZEM5azZQUm9IOHJ2?= =?utf-8?B?OGttaEQwNXZkZFR5K1JoUGRlL3UwZVhzT2h2eTNjdzZkbWpRbG1tVEJRWHNs?= =?utf-8?B?RXBBWjlOYnBMajAzaWlUZ1hjaGp2U2wwb3NteFpYQXJjWEFrcUtNQVVyOEZH?= =?utf-8?B?VEJqelQvTi91a0tYenlINXF5ODlrcEc3L3Jxc0VxV2p4TXBzOXF1aTVpUjli?= =?utf-8?B?NE9CM1ZVc1M5cWtwdUQ5OG9uMmwyV3M3Rnk0S3FWSEVuWGpOUEpMK3REdks5?= =?utf-8?B?Unc9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: b3ba0780-73d3-4029-e15a-08db9440c9d2 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Aug 2023 16:43:39.0383 (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: DiszUKzIKOvp+a3le61CnCj3/wId2z/UGGNbfE/TdpRFAJQF2sNcLhJgIRp/YjdvkOSN5RmBxRg54D5id0HH4H2r+2yYpIOjjpcfq+2SlUY= X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR11MB7768 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 Thu, Aug 03, 2023 at 11:18:09AM +0200, David Marchand wrote: > On Mon, Jul 17, 2023 at 1:09 PM Bruce Richardson > wrote: > > > 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. > > doxygen is invoked on the sources tree, so this is probably the reason > why such path is in the generated manual. > Maybe Thomas has an idea how we could handle this. > > In any case, I am fine with this patch as it is now. > I think I've found a fix for this. doxygen setting "FULL_PATH_NAMES" defaults to "YES", which is what we want for the HTML pages. However, setting it to "NO", I believe is correct for generating the manpages. Patch V3 on its way. /Bruce