From patchwork Wed Nov 29 15:27:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 134691 X-Patchwork-Delegate: thomas@monjalon.net 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 B65BC43402; Wed, 29 Nov 2023 16:27:56 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 39867409FA; Wed, 29 Nov 2023 16:27:56 +0100 (CET) Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) by mails.dpdk.org (Postfix) with ESMTP id 573C6402CE for ; Wed, 29 Nov 2023 16:27:55 +0100 (CET) Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-1d00689f5c8so14490895ad.3 for ; Wed, 29 Nov 2023 07:27:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1701271674; x=1701876474; darn=dpdk.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=WPQHPVcyZCrmajeK9z0awP1dVlXbCHR0fuYPMO7Cw4M=; b=pJLePay/O59wmI0mb6Uj/O2hgJh+HoWQGC908UVyyjY9vd5qzoSSa2ciau66PA78h4 w/vINApG0EjCHioWPq6dlT1hsObn1lQMzKNAH/4HKMCpAKFurs9U9lpmirO5QNw+qzCh 0VjA0mv0rplpVedx0V1g33Rs6LlBQD1cVs1AJ3RnPNjhCP6mycNU6YOlBBRXA7rWEFf9 eLc53nxTMBj54jVyIMvoFGsS/dRoTFI64dkHu/OC8fw1TRhDWE01ddrDq98i2R63m6uG VguQd9YUtLzRQpQpOGlnZsvICu5Ms5KVz/cvw0bbYzY8U8EoVf4DqrC5iAffKwnqVR5M nw/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701271674; x=1701876474; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=WPQHPVcyZCrmajeK9z0awP1dVlXbCHR0fuYPMO7Cw4M=; b=A2xGIcE+nC1/x0SdNqeDHIM0vrbRxw8DfpCdZEuIkrVt+m0ZbU+1pBPIL6bPnGh6RN kHgxtutwJfAtBodaoEOWtmpGrqvNY45nzdEwsA5ag7oNOaoNXzWB+LBudtSzwHCwFDLm l6KJopNuDWPg/P8Udrk9U9o/v0OqhczZHGWG0NEG73MjYjvidcC96xscVA2EZsRkuxPA W7R559bbUeHFclXNP/mjxMhdAgBdG5FTMaQBW/3BO2t8oAUQqixxSWsoIRa3EgTGT8ow FhZwLLwgFznSUrF4F+UvtVlLIoQGE0Y5w/wGiQX2ClcTOo1qc/V1GmFnwAaPO8ovgB4N 7m/w== X-Gm-Message-State: AOJu0Yx3PaZEx9cCffeWDJ6zjdg8vAO2TGYfvEsn+/N0Ddo0jOc8Ld94 pk5kHLj4yZSme6ydB2+B1X0QDvyM56OkOdBTYh0= X-Google-Smtp-Source: AGHT+IHmgJwYJamjf0prN5G671RbK6xC5JmT523mOg3eDcXOHTzHIW0RV6YhpW1o7f2mXT8l/lrF+Q== X-Received: by 2002:a17:902:c94d:b0:1cf:dd05:b57c with SMTP id i13-20020a170902c94d00b001cfdd05b57cmr10272767pla.46.1701271673933; Wed, 29 Nov 2023 07:27:53 -0800 (PST) Received: from hermes.local (204-195-123-141.wavecable.com. [204.195.123.141]) by smtp.gmail.com with ESMTPSA id g8-20020a170902868800b001cfc6388b5dsm6791819plo.260.2023.11.29.07.27.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Nov 2023 07:27:53 -0800 (PST) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [PATCH] doc: add sunset clause for experimental tag Date: Wed, 29 Nov 2023 07:27:38 -0800 Message-ID: <20231129152742.7984-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 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 The experimental tag is intended as temporary to avoid having all of DPDK APIs as experimental and thereby rendering the stable policy as worthless. Add some wording into the existing policy in doc. Signed-off-by: Stephen Hemminger --- doc/guides/contributing/abi_policy.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 5fd405258592..fbf26ea24fd6 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -328,6 +328,16 @@ new APIs and start finding issues with them, new DPDK APIs will be automatically marked as ``experimental`` to allow for a period of stabilization before they become part of a tracked ABI version. +The experimental tag has as limited lifetime (sunset provision). +It is expected to be removed in a future release. +The tag may be removed as soon as the second release with the new DPDK API. +After one year, the API must be stable and tag removed unless an +exception is approved by the technical board. + +For example, the symbol ``rte_flow_dev_dump`` was introduced +in 20.02 release as ``experimental``. The tag could have been removed +in 20.05 release, and should have been removed in 21.03 release. + Note that marking an API as experimental is a multi step process. To mark an API as experimental, the symbols which are desired to be exported must be placed in an EXPERIMENTAL version block in the corresponding libraries'