From patchwork Thu Aug 3 09:34:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Trevor Gross X-Patchwork-Id: 130464 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9f41:0:b0:3e4:2afc:c1 with SMTP id v1csp1062209vqx; Thu, 3 Aug 2023 04:00:16 -0700 (PDT) X-Google-Smtp-Source: APBJJlFWw8wNWvzNBoti5CpMd1KI9FfRNJSSWfg3iu/EPC2TqOH77tKu+Z0wzpYn60XRXJgjE3jC X-Received: by 2002:a05:6402:1299:b0:522:2af1:1ffe with SMTP id w25-20020a056402129900b005222af11ffemr6282501edv.9.1691060415712; Thu, 03 Aug 2023 04:00:15 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1691060415; cv=none; d=google.com; s=arc-20160816; b=c7aBBYROuRMSD7RyQX3T00blQNJTAcdxTMvLMeUnGxNbMNHfymVlIbB+wID7fU/sbv Nfcfa/NNi93m85zDkSpR9Zkm7P/lByAHhj82JZLYs7CT0181d3HfKFao1x9kBon0yIkK cnurnH+mLRfH0Uo3Y+v30G+f0aoSmP0DXdieB4vfZfH8tfopIZ2azAp69RtucURTPfuT 08wZQwwE9Icz92BmO4URfPUadmWKphyCp2uASilAAGJ1uKBLQVYmiPDXpYRx1GtkpZ6U gAPg7z/FN8rnWYViCQ2kSJeE0h6Rbe+alPjzJA7fv4IWdfKBcVbEgWIU5awQUFwgZDv+ v21w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=elT4B5g6oxJl47kw6yls2EuBwoQcgDU3XUgEiz68IfU=; fh=NWEzFAZVRz25+ue9dsydvAiW929cQ8aKCXsE+drPkco=; b=oldnkQnvyxhr7T4i5wpNS8OKta9SRk3TdmMYfOsi4VAynmYpk6SC2/3os82cXwdud0 u4i4+dGW3Tkl27+uExksP6tMPWpxb1jM7WgBisTa+/97MkMxTYG9UsRkkIiGwd9eIjss r1vlYtOJBgDJI+bfSW8Fz6EPujhkm6336XhFMVvBYOy/0BZYgjViFfV6VvEoFSP/URZZ jzFK/2rpASupcDCSGv8tCLwxmsuUBw0smClu6rCNtO2w3NzVM0cS31gQ37L6Owi8M0KB jG9Su1ebzG+IVHgHkiMkW5V6ltp4pybHuyi3BKvEQ3CR9kFO2DO4qXjLNC7m7HpJ0srP ZrSA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@umich.edu header.s=relay-2018-08-29 header.b=rOdabUCn; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=umich.edu Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id k22-20020aa7d8d6000000b00521d285fd10si10784110eds.385.2023.08.03.03.59.51; Thu, 03 Aug 2023 04:00:15 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@umich.edu header.s=relay-2018-08-29 header.b=rOdabUCn; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=umich.edu Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235175AbjHCJg2 (ORCPT + 99 others); Thu, 3 Aug 2023 05:36:28 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34020 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235152AbjHCJfw (ORCPT ); Thu, 3 Aug 2023 05:35:52 -0400 Received: from keen-gwydion.relay-egress.a.mail.umich.edu (relay-egress-host.us-east-2.a.mail.umich.edu [18.217.159.240]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2FA6A3595; Thu, 3 Aug 2023 02:35:37 -0700 (PDT) Received: from malleable-ellyllon.authn-relay.a.mail.umich.edu (ip-10-0-72-197.us-east-2.compute.internal [10.0.72.197]) by keen-gwydion.relay-egress.a.mail.umich.edu with ESMTPS id 64CB74E7.34E6EDA0.5CA2EDAA.70552; Thu, 03 Aug 2023 05:35:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=umich.edu; s=relay-2018-08-29; t=1691055335; bh=elT4B5g6oxJl47kw6yls2EuBwoQcgDU3XUgEiz68IfU=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=rOdabUCn6SgmcP257XywA71g1ugfTC+DQoJrsG4iVRfShYYngVvnvYEApMY36Gk1f ol3DhC8Wa6Cit3NISbyZ7YdGk1pdVgEPie3XCRLNOF5BjytEa4PVvm7Ts9jtikYsb/ p4H/5nt/BFcbhzJfxJOQOtHwPixE+M7V/5Valj19TijJ+YJf1Z4EkxTpjGESdpNmgM d9ZtZVCFT8ejRbK4voyTPu+ZC4pCCwt96KwEq2165O3uJ//O0kNedgabZoeDpcWSwO qErrmI+xKSF/DMCY4d4mebYdhgA2/Jc8c39ZZlI/5k349pAg+Xhi0zSTNEN0yVgmfQ L5zkNnwt6evHA== Authentication-Results: malleable-ellyllon.authn-relay.a.mail.umich.edu; iprev=permerror policy.iprev=68.32.216.219 (unknown); auth=pass smtp.auth=tmgross Received: from localhost.localdomain (unknown [68.32.216.219]) by malleable-ellyllon.authn-relay.a.mail.umich.edu with ESMTPSA id 64CB74E6.280818CF.72FCE152.1340056; Thu, 03 Aug 2023 05:35:34 -0400 From: Trevor Gross To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho Cc: Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , rust-for-linux@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Trevor Gross Subject: [RFC PATCH 2/2] rust: bindings: add warning about configuration dependence Date: Thu, 3 Aug 2023 05:34:18 -0400 Message-Id: <20230803093418.51872-3-tmgross@umich.edu> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230803093418.51872-1-tmgross@umich.edu> References: <20230803093418.51872-1-tmgross@umich.edu> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1773205366524148296 X-GMAIL-MSGID: 1773205366524148296 Add a note stating that binding documentation may differ from a user's configuration, to make users aware that published documentation may not always match a specific setup. Signed-off-by: Trevor Gross --- rust/bindings/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/rust/bindings/lib.rs b/rust/bindings/lib.rs index 9bcbea04dac3..869632c2341c 100644 --- a/rust/bindings/lib.rs +++ b/rust/bindings/lib.rs @@ -7,6 +7,9 @@ //! This crate may not be directly used. If you need a kernel C API that is //! not ported or wrapped in the `kernel` crate, then do so first instead of //! using this crate. +//! +//! Note that this module is heavily configuration-dependent, published versions +//! of documentation may not accurately reflect local configuration. #![no_std] // See .