From patchwork Fri Oct 20 14:19:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kevin Traynor X-Patchwork-Id: 133076 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 EA30A431BB; Fri, 20 Oct 2023 16:19:39 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B0152402E3; Fri, 20 Oct 2023 16:19:39 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 70D2940276 for ; Fri, 20 Oct 2023 16:19:38 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1697811577; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=PLp1TIxuE6rcuTOytLMh02+3DUBnezUm15WbP0s5Jhk=; b=AWnFNbcuShrVp6BmXC4En7POpIcrSpHak+y7caW2+DJKPfFgrfeHuDz7rNAMpMRjlJrI+q 4qvmxqF+9Qyz2F6JYs39BEsF/+Hc+qu9EpDnNzuVBp8V+h+97GsOYKVqEs6ajRrro36sL+ JDQW3Cnf8Fc1dpM2J19BodtyW3w91+Q= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-351-rEW4F3poNna4OixYHidb9g-1; Fri, 20 Oct 2023 10:19:36 -0400 X-MC-Unique: rEW4F3poNna4OixYHidb9g-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 39A99185A79B for ; Fri, 20 Oct 2023 14:19:36 +0000 (UTC) Received: from rh.Home (unknown [10.39.192.112]) by smtp.corp.redhat.com (Postfix) with ESMTP id 753642026D4C; Fri, 20 Oct 2023 14:19:35 +0000 (UTC) From: Kevin Traynor To: dev@dpdk.org Cc: Kevin Traynor , David Marchand Subject: [PATCH] docs: add note about experimental API in LTS Date: Fri, 20 Oct 2023 15:19:30 +0100 Message-ID: <20231020141930.426503-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.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 The justification and impact for changing experimental API on LTS branches is different from the main branch. So the policy that is being used for allowing experimental APIs to change is stricter on the LTS branches. This was not documented anywhere, so add some documentation. Suggested-by: David Marchand Signed-off-by: Kevin Traynor Acked-by: Bruce Richardson Acked-by: Ferruh Yigit --- doc/guides/contributing/stable.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 9ee7b4b7cc..8156b72b20 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -127,4 +127,12 @@ but may be considered in some cases where: * An existing feature in LTS is not usable as intended without it. +APIs marked as ``experimental`` are not considered part of the ABI version +and can be changed without prior notice. This is necessary for the API to be +improved and stabilized and become part of the ABI version in the future. + +However, in LTS releases ``experimental`` API should not be changed as there +will not be a future ABI version on the branch and compatibility with previous +release of an LTS version is of the highest importance. + The Stable Mailing List -----------------------