From patchwork Tue Aug 3 23:14:15 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jakub Kicinski X-Patchwork-Id: 491333 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-19.7 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BC3A3C4320A for ; Tue, 3 Aug 2021 23:14:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A0EF060F58 for ; Tue, 3 Aug 2021 23:14:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233311AbhHCXOc (ORCPT ); Tue, 3 Aug 2021 19:14:32 -0400 Received: from mail.kernel.org ([198.145.29.99]:38122 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232864AbhHCXOb (ORCPT ); Tue, 3 Aug 2021 19:14:31 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id DE8D760F56; Tue, 3 Aug 2021 23:14:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1628032460; bh=M8ItDQ92UG8jAZ6xq/140khubH0ks0zS3tj0C1FDnGU=; h=From:To:Cc:Subject:Date:From; b=FwYHaPtWQlZA7bD+xueJeCKMUQo2ZLiJDG/J2nMfLK4VDmF2sVWNolB8wrbaEJlcZ xOyEGgyQJmWZL/JSjK63zZa/cqUWOp55SK4IhJjGVZy6FPd0T0iu/ckS1RiGtiKekA 0vyoqsqI9Ww3Zmg7ur5tOAhCbHYnWLiQMnvLZ02REt7z8WqS2tevZZ30D6gHLKlbE4 T6I4gx5JL7+BFL/3BmboUSjI1eR/3k/2HkgoFNwJPOsu7CzwNs3BmZSSUjt034bLey AWCIlWlHHukPPzsw4rQm68K1J7Pa2ntEauRKVRgsy95nxe3xv77BShpRi1F7+w90WV Oal2OU1wyNqWQ== From: Jakub Kicinski To: davem@davemloft.net Cc: corbet@lwn.net, linux-doc@vger.kernel.org, xiyou.wangcong@gmail.com, netdev@vger.kernel.org, Jakub Kicinski Subject: [PATCH net] docs: networking: netdevsim rules Date: Tue, 3 Aug 2021 16:14:15 -0700 Message-Id: <20210803231415.3067296-1-kuba@kernel.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org There are aspects of netdevsim which are commonly misunderstood and pointed out in review. Cong suggest we document them. Suggested-by: Cong Wang Signed-off-by: Jakub Kicinski --- Documentation/networking/netdev-FAQ.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst index 91b2cf712801..e26532f49760 100644 --- a/Documentation/networking/netdev-FAQ.rst +++ b/Documentation/networking/netdev-FAQ.rst @@ -228,6 +228,23 @@ before posting to the mailing list. The patchwork build bot instance gets overloaded very easily and netdev@vger really doesn't need more traffic if we can help it. +netdevsim is great, can I extend it for my out-of-tree tests? +------------------------------------------------------------- + +No, `netdevsim` is a test vehicle solely for upstream tests. +(Please add your tests under tools/testing/selftests/.) + +We also give no guarantees that `netdevsim` won't change in the future +in a way which would break what would normally be considered uAPI. + +Is netdevsim considered a "user" of an API? +------------------------------------------- + +Linux kernel has a long standing rule that no API should be added unless +it has a real, in-tree user. Mock-ups and tests based on `netdevsim` are +strongly encouraged when adding new APIs, but `netdevsim` in itself +is **not** considered a use case/user. + Any other tips to help ensure my net/net-next patch gets OK'd? -------------------------------------------------------------- Attention to detail. Re-read your own work as if you were the