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 086E342C3E; Tue, 6 Jun 2023 11:19:08 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7AB3540A84; Tue, 6 Jun 2023 11:19:08 +0200 (CEST) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mails.dpdk.org (Postfix) with ESMTP id 6373C40697 for ; Tue, 6 Jun 2023 11:19:06 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1686043146; x=1717579146; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=XpBlFDDXxkoSLY+4xg007bNtItUcsS0AfriROoH91fo=; b=Js1kzkjt2leUufzlwqnadsatUHSHMq8pxDk80hx4FSFl7qkHXfPZ3Koz vXZTgn4o+sBY04CDMEqU2EQ0lSFLp3gm20/GH8W1Y1Hzc8/9kheQS9Q/d aEPIpn4CHb+9OBm/fnM8AfffrECFJslqKW/by+gXWFoEBSjHQaY8SnGDe x33xKvm0fGQNahgPA1GcfAa/8RdOzZfa8o3FFXRXsA3d37R7wGKfGmIYC G09/JFiotcPTGcZh+OjDddkffEASGAWRha5FvBWlztTivgDsUNHaGBCrj nT76XHfn/2oaTLHbhAOhNjAxGcf1ARd07plw+LQq9y84pk3tC0MQrR3im A==; X-IronPort-AV: E=McAfee;i="6600,9927,10732"; a="359930314" X-IronPort-AV: E=Sophos;i="6.00,219,1681196400"; d="scan'208";a="359930314" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Jun 2023 02:19:05 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10732"; a="686465589" X-IronPort-AV: E=Sophos;i="6.00,219,1681196400"; d="scan'208";a="686465589" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by orsmga006.jf.intel.com with ESMTP; 06 Jun 2023 02:19:02 -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; Tue, 6 Jun 2023 02:19:02 -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; Tue, 6 Jun 2023 02:19:02 -0700 Received: from NAM11-DM6-obe.outbound.protection.outlook.com (104.47.57.171) 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; Tue, 6 Jun 2023 02:19:01 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LcEWUM9pzdYzCHtBAvqtn9+4DC8elMztC4W8HqOakTRX3uh+tlasTGsmLVm7U2sZ0Js3Q7orO4/dUHie6xg4fgb62Zx6CpusXavG+rNqgKnnj2SeyUhngcCfMOs0iebkDnTuxPX4RdPNhm3Veabvd4hwIvpIzG++MInxEuIrhuFPOPyQfcTTWnOH6BDUiJreacY3PwLz5P/NCYU1zbNoYvUaCMIcLhIXYSijbrcQC01SvdUT9oUx6zvdZ2+tHFeldl14Hpoxndc0gdlv+rAR9X7P18ooVfJ3IBYmPa9YJWKaOLPlfdobxEVxK++hUjaRDVgxusscPN+AxJSLXW9Umw== 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=zObuK2BDtnuYjDN+aFcTm6Z3QNDcSMojnxLIsP98fag=; b=RVj6uDZBfqeHn2GhrkuaYhS32vP1LaADWyuzxJl/scjtWm2k04YNFvfvbxuFIDs+I2Org+dmrH/vUG0QGBe1tllDZgly46gUIe/sKsBiOJVddONI8ECVp+xMl7t7afx9xsJGW98/rPejGVSBeGoxBxAR5SeZl+5tF3hnmi0PZiVnlCxV63gUB4x8iSJ/rMQogH+Yx/zOZ7WSAQEL+Wi4GUKdpv6BM8ZnrvrtqY2zYjcC4WHm7fXY1WsMnpkQuK8Piyzmyau0nRW/DSgjUx8l7Yb0ewme/VbfRXCXE7X+3/kGgbsAOMZXzvJoEfzK0f+PdFg7hZr//SXUoOnvV8/+HA== 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 MW5PR11MB5931.namprd11.prod.outlook.com (2603:10b6:303:198::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6455.33; Tue, 6 Jun 2023 09:19: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.6455.030; Tue, 6 Jun 2023 09:19:00 +0000 Date: Tue, 6 Jun 2023 10:18:53 +0100 From: Bruce Richardson To: Jerin Jacob CC: Subject: Re: [PATCH] doc: build manpages as well as html output Message-ID: References: <20230601153801.118616-1-bruce.richardson@intel.com> Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-ClientProxiedBy: DUZPR01CA0042.eurprd01.prod.exchangelabs.com (2603:10a6:10:468::9) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|MW5PR11MB5931:EE_ X-MS-Office365-Filtering-Correlation-Id: ba3cad09-ae2a-4add-f6f1-08db666f0fd3 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: hkjR8Ln5YbYcGe0BU/iPX9JrVjBQY6r6D7XwoMNul7RhSha2KOYKOqE55jDtxTBtuCzzeGKrmT46YfaYFMp6FUqcki2DjErWRs+nuohzqyWiVjdVRv6rOfl0rduqMLUH6C89348m24gqDhq8lL/X94NHAkEpYH94Hh8W/MarrR7iWXq5XCBGln482LE4rIVXNQ7aU4rM5xhcycxRMlDWU3lvNXFJ1wuiFk1XcVlwCYL7nGY1ymDwqpm7BPF1rdjr9TeglkvtI2+c/OAV1G0s7mL4YEF9UJLJY/62QZPV9fM/0IRc+lD/yUDFOBCeyzbhJEdf5MF97IhtI7JjFo1NNBkwqClOcxhwVvHg+4WGZsMSstGo1xoz9sg8x2NX0SFlibiKXneWGBqKQQOkk9P5zWHdaahjmg7oWGJuuhTd3VPdbMzXAki5LP6NCQyFaaHNToCnlwKZTPdNZJa+BnhznvMr1F9h9QLJmFSdNfTIVFCRUGUDU/VDOMAnkfJyJSrN88ko+2lSQafc8jR3bjF14j0N5u4Hx8xBPHsJUVXqXxg8+PeaAspHnEV5zOIKOEoo 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)(366004)(376002)(136003)(396003)(346002)(451199021)(83380400001)(2906002)(86362001)(82960400001)(38100700002)(6486002)(41300700001)(316002)(6666004)(5660300002)(8676002)(8936002)(478600001)(66946007)(66556008)(66476007)(6916009)(4326008)(6506007)(6512007)(53546011)(26005)(186003)(44832011); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?ZEw4aUV2UnZyRktVcEtwVXVVNVRGeWx1cC9LRDNZVkhFYlBMNVNxelNYVmNR?= =?utf-8?B?UUVFZTZ5b2EvUm1RWnFjOVFTWFkwYldsd2hZbFdXcFZLTWEwUzMveTFXMzNl?= =?utf-8?B?QW52Q3JTZVRaek9GalJmL0dmaGlmWjVLMkpIZk55QXZzTGJ3NklxR0huZ0pZ?= =?utf-8?B?OG9oNnNHN29FOGdua1RnQWlNZEhUajVLcVM2NXA4RTJseU55WmFZSm43QnJj?= =?utf-8?B?RkVLRkozSGdDQko0Tk02VzUzdjVQRCtld2piTDNvVmZKeXJyUVV2MFBIb3c4?= =?utf-8?B?M1phMUNpdEVVb1dkNHIrMVY1YzkvZ0I4UDJNWnlwWXUwakMzMU5HQ3NCcG8v?= =?utf-8?B?eTErUVpiWFVwblhsVGwxenNhc0ZiWWE3SUh3VXBqdmJTTFlDR293eVlNSmI2?= =?utf-8?B?aHVLdG5BWUhjeWROWllFakVSS1BobVhCeE1ESXcvSStSdVV1NXVEZ2NmM2lo?= =?utf-8?B?QW1abTk1RUhVdUE4VzdYVmY5RTB3NnN2R1pOWHl1UUVNS2w3QkZVWjBvOHlh?= =?utf-8?B?eFdhcjVaZ1pHOExBblFCVjhLc2oxOW1qcnRyMHBmVkMrbGlKZUdjeDFPNWJ3?= =?utf-8?B?cGVyYThWNGE0TXkxQlFPTWs3b0krRmNnUjVKR1laTGJnbWF1QnJqK3BCRmhk?= =?utf-8?B?ZUJKTHpHOW02LytKcFhOQlNtZlpOMmlPanV6M0Nvd1ZVbVkzSjBlMTYveU9X?= =?utf-8?B?eGNvK2JqYWExWXlZdExmRWhYVk8yTzhGM2o3YWdFOWthS3VNQzlqNnVJTFRz?= =?utf-8?B?Z29icHUwNUsyUGZMSlFvTG9ZclRoSm9CNDd3aHRselN5SGk4aDl0L3JCZGhW?= =?utf-8?B?NFlva1NMNXRXWkM0Y3NrK2dJck5mSkFvVjcvQW1KMUYrV0d5OVQyUGVINnlY?= =?utf-8?B?MkFhT0VtRERLQXk2b0hFQUI5a0F1VUdKYmxFL0ZYSUo0aUJRVGc0R005dHVR?= =?utf-8?B?RkhFbXpPbSsrdUlVUUFleHRMSUJueWdwN3FUaTc2NFd5a3ZpM1YrdWxoZjdt?= =?utf-8?B?NnBnZHBCVVJqaE0yRXd5SWRMak13ZFd0UTNzRzlqaXZFcTF6bllPQUlOMFdV?= =?utf-8?B?ekc4QW9IeE1FMDhsS1RHTFVRYVZKcVJ5K1hxRWVKSlJjRnZNcElLeituQ0Fj?= =?utf-8?B?NjVUVlZXOGVPOFNtMFp1OG9XdmVSU2VkWC9HWFVkWGtKVVhDU3ZDaDQza2Nm?= =?utf-8?B?UzFvYWErTlpFL2tEUmpkaUw2WFc1aUE2V3czV1JkNFlhK1lOTDJxWW9OaVlj?= =?utf-8?B?TDR5OFEvY1IvRFpaa1VIT0ZPZDAzWkxJRFpwMkw2NHFpMjRLVGQ2bGJJblJZ?= =?utf-8?B?ZDJzdHlGeXN0bHB2MFIvQjRRMjRGOTR5NTRuSW5Bakhad2taajU4MTVIYnli?= =?utf-8?B?cDIwZzBEdE1GUjI5ZUF2WEllbDNrTmtEOVFqYjRyMzZsMFVNUGdxeEt6S2Zm?= =?utf-8?B?M3hPVURqbzB5QjdLNkFmNHZwOTdGVDArb2p4ODNPa1lpbHRGSXJ0cUlQdjNi?= =?utf-8?B?Z3ZuZitzcnpsdllNQjhkcUNBMGZmeFJRcDhLdG54Y1lTOSt4aTR0VzJhSUw0?= =?utf-8?B?RiszaG12Zm5Rd2hJQzQrWEc0VGhhS09FRzF5QXpXMmFPVm9adVhQMTZzT3pj?= =?utf-8?B?U1JKWmRXdVBzbzZLVDZkNHRjQTV6ZUFPbEF2TTJQZWs2VDJ0RU9vNjd3clBq?= =?utf-8?B?OVoyVkJXRVVlOWJHTDZjNW5MU3ltbGJmTzh0Vlc1TDVzRnM3NkpSVUV0Nm1Z?= =?utf-8?B?REtpOCtscVVXQ1FVQ1BrZGFMMFdrMHBGcW9DZUV5cWVwN2lLeHBCZGRibXQ5?= =?utf-8?B?cXJoaGdnWTlYOEYwamlwUmJ0Y2hmR2dyc3BtTjlpaDlDK3BRYnZnMHZwMDBI?= =?utf-8?B?M1NHMFNJL1NpS2svSG4wQ3ZPR3hqQWxhcFJHZ2RwYzA0dSs1NzdsdHFXbEVi?= =?utf-8?B?anNHM2ViTGVMMEZOSVhIeE5kZkt6ZnNqcXR3QXlKSlpMdVJwanVyaHVoTkpa?= =?utf-8?B?SmtWRW4wd04rYk9uWDNxbk5CemNZd0RVaUdZeUFDTHRMUWtLTUxMendhRW02?= =?utf-8?B?N0M2MjFzeXB4bmR5NW92eG84RDlWRUVHaGNwRHdVWFdveVJlNzNuOE95TWlQ?= =?utf-8?B?NDliQ3JtaytrbDdWY1hWZnRqVEJLTmZKOGZ2SDFyRy81aTVrSkRsb1VqM3Ba?= =?utf-8?B?bnc9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: ba3cad09-ae2a-4add-f6f1-08db666f0fd3 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Jun 2023 09:18:59.9088 (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: MiI2b2mT6o8vvSMqktn0TSWORmfHFLzDmRe34CkvC+nwJvbEmLH6W/lQNdyKWiSKykM2zyDzM1APTPQKs5uu/2sHC5AOFwjWTQbNQwpWR/w= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW5PR11MB5931 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 Mon, Jun 05, 2023 at 10:50:48AM +0530, Jerin Jacob wrote: > On Thu, Jun 1, 2023 at 9:08 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 > > > + > > +mandb = find_program('mandb', required: false) > > +if mandb.found() and get_option('enable_docs') and meson.version().version_compare('>=0.55.0') > > + meson.add_install_script(mandb) > > It does not look like just executing mandb it is adding these man > pages to database > > log: > Running custom install script '/usr/bin/mandb' > Purging old database entries in /home/jerin/.local/man... > Processing manual pages under /home/jerin/.local/man... > Checking for stray cats under /home/jerin/.local/man... > Processing manual pages under /home/jerin/.local/man/cat1... > Purging old database entries in /home/jerin/.local/share/man... > Processing manual pages under /home/jerin/.local/share/man... > Checking for stray cats under /home/jerin/.local/share/man... > Processing manual pages under /home/jerin/.local/share/man/cat1... > 0 man subdirectories contained newer manual pages. > 0 manual pages were added. > 0 stray cats were added. > 0 old database entries were purged. > > [main][dpdk.org] $ man rte_flow_create > No manual entry for rte_flow_create > > # Following works by providing the path i.e man pages created properly > only db update is missing > man --manpath=/tmp/i/usr/local/share/man/ rte_flow_create > Yes, that is correct. If you install to a non-standard location, then yes you need to update manpath yourself. However, in case you install to a "standard" location, then running mandb will update the database for you. I believe this is the behaviour we should have. I view it as the same as installing binaries in a standard vs non-standard path - if the binaries are placed in a standard location then they are found automatically, but if installed in a custom location, then the user is responsible for ensuring all paths are correct. /Bruce