From patchwork Wed Oct 5 09:16:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Mattias_R=C3=B6nnblom?= X-Patchwork-Id: 117373 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 43682A0542; Wed, 5 Oct 2022 11:20:35 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 44E7142B6C; Wed, 5 Oct 2022 11:20:12 +0200 (CEST) Received: from EUR05-AM6-obe.outbound.protection.outlook.com (mail-am6eur05on2071.outbound.protection.outlook.com [40.107.22.71]) by mails.dpdk.org (Postfix) with ESMTP id 12F16427F3 for ; Wed, 5 Oct 2022 11:20:10 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HPWi2M4kd0TJPpXZTRxttuMywmHvCF/sDbU7rn+HC324a+/OmrvpLEszMR+brozJYTCZ8Y7nzcPQ/SoA8wqalEhV/y7/vx7PA+YInMVuS9CjW72EiuYAW/N0Pb9MNFaLFdl7md8o33cM7bHmT/kcqgOvvntgw6iLwbMe/A7V+JurQRXeukihGspN9oBxkpd7XYWucUOmqoYApkPNXkuSngJzcyxZkA5g+JJvOu2rB2RfCZSP6w3UWtWJOLrkKIRg0LUB7e3Gn+JSbdFRHrc3g36IiTMg1bxrE5rWpKr0h0So142ZUxiMwHKmeexD+w3RitNWRrN2t88OZ7QhbyqCmg== 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=2LS0P000MZ7yF1YZP1Cn00rREYWnihJtZCoXwThnuGs=; b=cfJiqLKOQC8a7gXkOKKiRFIXlXS2s346o9tMM+8Am/miMJWl/nt1Z64UT2QGjCTyauo+zGZNPCAImh9pzV+8egSZnM/lYIbMuiDn3dbQ3u6MdLoC5KG8lHaUKVneoIO1yC0GJEqPMffuv3uWSIpzk7BsABAMwOsEetTjmgVSOLQ4IzZfZcg1EqinY3qcuSMdy4xqrfukBDsKGthadiFMQBCi1seWTPbXG0Y+zNK9ZUxsnPW18RZfcndtDRF4LfZyx7kuckcMoFSV9kQS1TcsJ7MVP6uaXjvGK7qPkGvcnIIkflyIygbwNv1CRxqPEXb2NbxIm61Epq/5XPWJSB7qkw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 192.176.1.74) smtp.rcpttodomain=arm.com smtp.mailfrom=ericsson.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=ericsson.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2LS0P000MZ7yF1YZP1Cn00rREYWnihJtZCoXwThnuGs=; b=Ji6WaOViqytjQfXcr4HqpoAoDsHc30fySTJZf9YYSn3uOF2gnaWP4fsE9rjMreSmXHPqCvy7a5IXYPWGzSSIPxKCqEodmO64ACJMSLwRulGjczn5Osx4NLRK7MIS3T50G1g4rO4FRkbYO5F2x5yoE+MdpDl09hBhvf+Mm0CSyf4= Received: from OL1P279CA0023.NORP279.PROD.OUTLOOK.COM (2603:10a6:e10:13::10) by DU0PR07MB8905.eurprd07.prod.outlook.com (2603:10a6:10:316::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5709.10; Wed, 5 Oct 2022 09:20:08 +0000 Received: from HE1EUR02FT019.eop-EUR02.prod.protection.outlook.com (2603:10a6:e10:13:cafe::98) by OL1P279CA0023.outlook.office365.com (2603:10a6:e10:13::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5676.32 via Frontend Transport; Wed, 5 Oct 2022 09:20:08 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 192.176.1.74) smtp.mailfrom=ericsson.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ericsson.com; Received-SPF: Pass (protection.outlook.com: domain of ericsson.com designates 192.176.1.74 as permitted sender) receiver=protection.outlook.com; client-ip=192.176.1.74; helo=oa.msg.ericsson.com; pr=C Received: from oa.msg.ericsson.com (192.176.1.74) by HE1EUR02FT019.mail.protection.outlook.com (10.152.10.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.5709.10 via Frontend Transport; Wed, 5 Oct 2022 09:20:08 +0000 Received: from ESESSMB501.ericsson.se (153.88.183.162) by ESESBMR506.ericsson.se (153.88.183.202) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2375.31; Wed, 5 Oct 2022 11:20:06 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.189) with Microsoft SMTP Server id 15.1.2375.31 via Frontend Transport; Wed, 5 Oct 2022 11:20:06 +0200 Received: from localhost.localdomain (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id 05FE81C0060; Wed, 5 Oct 2022 11:20:06 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: Van@dpdk.org, Haaren@dpdk.org, Harry CC: , Honnappa Nagarahalli , =?utf-8?q?Morten_Br=C3=B8rup?= , nd , , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [PATCH v2 6/6] service: provide links to functions in documentation Date: Wed, 5 Oct 2022 11:16:15 +0200 Message-ID: <20221005091615.94652-7-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20221005091615.94652-1-mattias.ronnblom@ericsson.com> References: <20220906161352.296110-1-mattias.ronnblom@ericsson.com> <20221005091615.94652-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: HE1EUR02FT019:EE_|DU0PR07MB8905:EE_ X-MS-Office365-Filtering-Correlation-Id: d4d63a99-4664-49f1-5ca2-08daa6b2cc03 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 56jiSDj+xTypOvRxyo5MXNuQH7oANWhEzTe2v0Gt3uvrkYCtkyGEX8U346UChMet3UGaDUzGp6BSlwtOug+G8bLaCatEsuG5HDE0ymzb1R010OJx+E32I3KM7foiJYFKt2d+OV+ynzraNhBzkByBXeKuvBSsEuwaOgdCkgcmINVGXKDssnPgEGeBWVIWUZsL+l5Z+q4890GXBcgKD+SUFxqwhSxnG6lLIiWalSxRYNjlndRqAYbXg3cvolxnBzRZ8YnXM/7MNEGs2n4mVpWGsqyRBIijkwBjCxhbi5u3absY9yBIqrZ5zj9C/CA0DJc+uDJ38UmvErhGA4WfhuEB3HPwTk9TLooX2S0LtDUW8IUIDH1SJ28irp8wQW12abb/2uZt1Q5aA/qXkXn8fYRuIg6WJfxdWcZ2sunhpe/8nEp9T7AsM80LBqXDBHbq8ukhHAostywLZmZiNmIKARCpEZXn7G3jGP6ADuOG6RwX9hGh8GGwZ+nj1b52l8tUavehODxeowzAeAxvpxaB7FpwuwPhMa7OJZCRZOb1flB0AREKPZb8MRZUkbYLXf+zBoYDhjRDr3Ij7c5oa3declFjcnQtoGU8LtcxXusNHmw7G99dc0gE7947Zj0106wSeVwQEtm7b/q6vsr/D2sJzWIT421COpBpK00XcU406BpoxiU8vVHy8i54h4SJXRIOpwiS2q0CYXQuei8QB6+9r4tNInRFVO6bxlnUB6xnY3qyXuA4kpdDIi1TaULZ3JZp8StysnuLs41eG78hBUb4hdQUEg== X-Forefront-Antispam-Report: CIP:192.176.1.74; CTRY:SE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:oa.msg.ericsson.com; PTR:office365.se.ericsson.net; CAT:NONE; SFS:(13230022)(4636009)(376002)(136003)(396003)(39860400002)(346002)(451199015)(40470700004)(46966006)(36840700001)(2616005)(478600001)(70206006)(40480700001)(70586007)(36756003)(186003)(1076003)(41300700001)(8676002)(336012)(4326008)(36860700001)(6916009)(54906003)(82740400003)(82960400001)(40460700003)(2906002)(356005)(26005)(6266002)(316002)(7636003)(8936002)(5660300002)(6666004)(86362001)(107886003)(83380400001)(82310400005)(47076005)(66574015); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Oct 2022 09:20:08.3195 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: d4d63a99-4664-49f1-5ca2-08daa6b2cc03 X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=92e84ceb-fbfd-47ab-be52-080c6b87953f; Ip=[192.176.1.74]; Helo=[oa.msg.ericsson.com] X-MS-Exchange-CrossTenant-AuthSource: HE1EUR02FT019.eop-EUR02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU0PR07MB8905 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 Refer to API functions with parenthesis, making doxygen create hyperlinks. Signed-off-by: Mattias Rönnblom --- lib/eal/include/rte_service.h | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/eal/include/rte_service.h b/lib/eal/include/rte_service.h index 70deb6e53a..90116a773a 100644 --- a/lib/eal/include/rte_service.h +++ b/lib/eal/include/rte_service.h @@ -37,7 +37,7 @@ extern "C" { /* Capabilities of a service. * - * Use the *rte_service_probe_capability* function to check if a service is + * Use the rte_service_probe_capability() function to check if a service is * capable of a specific capability. */ /** When set, the service is capable of having multiple threads run it at the @@ -147,13 +147,13 @@ int32_t rte_service_map_lcore_get(uint32_t service_id, uint32_t lcore); int32_t rte_service_runstate_set(uint32_t id, uint32_t runstate); /** - * Get the runstate for the service with *id*. See *rte_service_runstate_set* + * Get the runstate for the service with *id*. See rte_service_runstate_set() * for details of runstates. A service can call this function to ensure that * the application has indicated that it will receive CPU cycles. Either a * service-core is mapped (default case), or the application has explicitly * disabled the check that a service-cores is mapped to the service and takes * responsibility to run the service manually using the available function - * *rte_service_run_iter_on_app_lcore* to do so. + * rte_service_run_iter_on_app_lcore() to do so. * * @retval 1 Service is running * @retval 0 Service is stopped @@ -181,7 +181,7 @@ rte_service_may_be_active(uint32_t id); /** * Enable or disable the check for a service-core being mapped to the service. * An application can disable the check when takes the responsibility to run a - * service itself using *rte_service_run_iter_on_app_lcore*. + * service itself using rte_service_run_iter_on_app_lcore(). * * @param id The id of the service to set the check on * @param enable When zero, the check is disabled. Non-zero enables the check. @@ -216,7 +216,7 @@ int32_t rte_service_set_runstate_mapped_check(uint32_t id, int32_t enable); * atomics, applications can choose to enable or disable this feature * * Note that any thread calling this function MUST be a DPDK EAL thread, as - * the *rte_lcore_id* function is used to access internal data structures. + * the rte_lcore_id() function is used to access internal data structures. * * @retval 0 Service was run on the calling thread successfully * @retval -EBUSY Another lcore is executing the service, and it is not a @@ -232,7 +232,7 @@ int32_t rte_service_run_iter_on_app_lcore(uint32_t id, * * Starting a core makes the core begin polling. Any services assigned to it * will be run as fast as possible. The application must ensure that the lcore - * is in a launchable state: e.g. call *rte_eal_lcore_wait* on the lcore_id + * is in a launchable state: e.g. call rte_eal_lcore_wait() on the lcore_id * before calling this function. * * @retval 0 Success @@ -248,7 +248,7 @@ int32_t rte_service_lcore_start(uint32_t lcore_id); * service core. Note that the service lcore thread may not have returned from * the service it is running when this API returns. * - * The *rte_service_lcore_may_be_active* API can be used to check if the + * The rte_service_lcore_may_be_active() API can be used to check if the * service lcore is * still active. * * @retval 0 Success @@ -265,7 +265,7 @@ int32_t rte_service_lcore_stop(uint32_t lcore_id); * Reports if a service lcore is currently running. * * This function returns if the core has finished service cores code, and has - * returned to EAL control. If *rte_service_lcore_stop* has been called but + * returned to EAL control. If rte_service_lcore_stop() has been called but * the lcore has not returned to EAL yet, it might be required to wait and call * this function again. The amount of time to wait before the core returns * depends on the duration of the services being run. @@ -293,7 +293,7 @@ int32_t rte_service_lcore_add(uint32_t lcore); /** * Removes lcore from the list of service cores. * - * This can fail if the core is not stopped, see *rte_service_core_stop*. + * This can fail if the core is not stopped, see rte_service_core_stop(). * * @retval 0 Success * @retval -EBUSY Lcore is not stopped, stop service core before removing. @@ -308,7 +308,7 @@ int32_t rte_service_lcore_del(uint32_t lcore); * service core count can be used in mapping logic when creating mappings * from service cores to services. * - * See *rte_service_lcore_list* for details on retrieving the lcore_id of each + * See rte_service_lcore_list() for details on retrieving the lcore_id of each * service core. * * @return The number of service cores currently configured. @@ -344,14 +344,14 @@ int32_t rte_service_set_stats_enable(uint32_t id, int32_t enable); * indicating the lcore_id of a service core. * * Adding and removing service cores can be performed using - * *rte_service_lcore_add* and *rte_service_lcore_del*. - * @param [out] array An array of at least *rte_service_lcore_count* items. + * rte_service_lcore_add() and rte_service_lcore_del(). + * @param [out] array An array of at least rte_service_lcore_count() items. * If statically allocating the buffer, use RTE_MAX_LCORE. * @param [out] n The size of *array*. * @retval >=0 Number of service cores that have been populated in the array * @retval -ENOMEM The provided array is not large enough to fill in the * service core list. No items have been populated, call this function - * with a size of at least *rte_service_core_count* items. + * with a size of at least rte_service_core_count() items. */ int32_t rte_service_lcore_list(uint32_t array[], uint32_t n);