From patchwork Wed Jan 31 20:23:26 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Valentin Obst via B4 Relay X-Patchwork-Id: 194925 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:693c:2685:b0:106:209c:c626 with SMTP id mn5csp4301dyc; Wed, 31 Jan 2024 12:28:29 -0800 (PST) X-Google-Smtp-Source: AGHT+IGdaShPyQoimUr3DllxHFDnPVqU0Xv4SPKyRV72Fw4WhMIEipvi7/Ixzu04rXuBPeah6AZ3 X-Received: by 2002:a05:620a:394e:b0:785:43ef:99aa with SMTP id qs14-20020a05620a394e00b0078543ef99aamr236280qkn.50.1706732909363; Wed, 31 Jan 2024 12:28:29 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706732909; cv=pass; d=google.com; s=arc-20160816; b=cl9RUko0S3oMZT/wfJWt/b0rtWlglfCAV6WbWBZo4z5xqCmrAF5CUjwxgZiiTbYD9U RdzbmvJMfNUjB5xitoGQt4HbOtfk/6jV0tySBY7Pftry4wtzkF7nK/uzWCy5D/x/7X8a ZVffWQttK8Nw4Oyqw8Fgm1RnjX0oXYjP3TYYlJUFsT1oWeArAVUZb7x8UV2owTpPJifB +/+k1ZFuyQE5kSKJ4x/ZDuQdY08/DI7o1KtLb/s7x6vV1FKi7q0XgBX7lOgOV1FVLIgX j4sIsReY+aYXac+xz90IiYXIKfbcMdVMr1SBg9J9cTtfTUEOwRjUEy1MFKT7gPJyvUea /gdQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=reply-to:cc:to:in-reply-to:references:message-id :content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:subject:date:from:dkim-signature; bh=O60lgSOACH9U4hkUj/EiX1ibTPxm+TJYQaA/XdDxtfM=; fh=LxAPvi5zmrgE7e8Dvh+5MGMD/482tUUzwTpi+RgrRc8=; b=hEo9f055Ty5TipAdGnHHmSNxUQnOFnv8ab9oGngA7hZ3Ppc3eBEe/i3Oip8kdU5B0e s72OkKeZuroF4ARqbMpml7dKcCcnnraSDEGhsKbmbMu7fVM8+Bt8XQbQb78QfwSzPpMO pOaojRyKYCmaRpp96IG1Cpi10QWipGua59nPVX68Kdpqifb+tIeGVaDjN53kMCdoWaBZ FL7TRV1u800wdPkqIDCKvNX3SvW6+vL9Ozx1YiyILoYJck5wiaMyOGK6ycUp1JvuObcf Y++lYNZ6rQOeyQQqV69Hq1iap8mRFPQVZoUCn4eMSJt8Px/Sqzch777vGJue3+APVgsi YkCg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=mf8FNPTV; arc=pass (i=1 dkim=pass dkdomain=kernel.org); spf=pass (google.com: domain of linux-kernel+bounces-47069-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-47069-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org X-Forwarded-Encrypted: i=1; AJvYcCXjP7bwJtAySdjtGN7lAKeWvihjnm6CxeSYrUzBYfiwAs+DUBRJ4nx3wVMZGD7A6KApWZOmJvgNIBkEMYWHp7j35q+X/A== Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id b25-20020a05620a119900b00783f41175a9si9340987qkk.426.2024.01.31.12.28.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 12:28:29 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-47069-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=mf8FNPTV; arc=pass (i=1 dkim=pass dkdomain=kernel.org); spf=pass (google.com: domain of linux-kernel+bounces-47069-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-47069-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 2ADEC1C20FCD for ; Wed, 31 Jan 2024 20:28:29 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id AE8AC13BE85; Wed, 31 Jan 2024 20:24:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="mf8FNPTV" Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 874163FB1E; Wed, 31 Jan 2024 20:24:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706732649; cv=none; b=bGq16jAkYXFMXXX2FCwGkrL7mkeXaGoCcUoicEU8m5ekzsmHbquMvxV1VWSKV4Kgd6gdmz3Hqo+2iYhQ35NNpdS2pQNc1DSdi3dFVtj6XAkG/loytiiIVywXqTPGSzY4hoRYbCKeLPa49diN2yS93P1ojlBfrJwzzVK0i7gpEyY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706732649; c=relaxed/simple; bh=kdmvq8FHVvrhi/nhman0CJ4rcR5nU6JHLMJSECky02U=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=X0obyrUKO1zH/hsKu8UlJjR9/tOWj74XQHHbzVfakCeL9o9K5280UgfDo9IOtcWUrm51zGz9gzSbVjWzjACrNb13+1Xu1r8deh18MYO+RaUqi3Vk/EokpmauoEL2LR+MjNWr0njfRwbOxSoU8QTj2uLZxG6kCJKWt0l0cPGQYdE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=mf8FNPTV; arc=none smtp.client-ip=10.30.226.201 Received: by smtp.kernel.org (Postfix) with ESMTPS id E4FF6C433B1; Wed, 31 Jan 2024 20:24:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1706732649; bh=kdmvq8FHVvrhi/nhman0CJ4rcR5nU6JHLMJSECky02U=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=mf8FNPTVEHtCFME3wbDfqX8jnVZPnLquQ0k0gghT4YZgFFDRo4r8sJ5jR7RDhQKLM sKRr1cvgO8gW5G7tY9VEB9rUHHlQVQjjXNttVeTefEMNoTzJNr9XZgeCa6pZg9VGqz NVnka9Y7Jib63yQlyvCdgfKrb+0CCxvS0YzyfG0zRKjk2QyjVVc3m5vcSjm92xHpot 9JWRqyW9p8fJtwpAxHwbaSR6QbBU9/X7OsWhpNxhgHk4S/ggOIPfxrsUWzXhw/7pH7 dM3ZBL4Q/k3KSQGz3WRnVxw3asICcsw32ztX8pOy+ayUeXXEBQ5OqpoCNW02ugz6RW P4sjJ/CDb/6eA== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id CD724C4828D; Wed, 31 Jan 2024 20:24:08 +0000 (UTC) From: Valentin Obst via B4 Relay Date: Wed, 31 Jan 2024 21:23:26 +0100 Subject: [PATCH v3 04/12] rust: kernel: add srctree-relative doclinks Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20240131-doc-fixes-v3-v3-4-0c8af94ed7de@valentinobst.de> References: <20240131-doc-fixes-v3-v3-0-0c8af94ed7de@valentinobst.de> In-Reply-To: <20240131-doc-fixes-v3-v3-0-0c8af94ed7de@valentinobst.de> To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Valentin Obst , Trevor Gross , Martin Rodriguez Reboredo X-Mailer: b4 0.12.4 X-Developer-Signature: v=1; a=ed25519-sha256; t=1706732646; l=1495; i=kernel@valentinobst.de; s=20240131; h=from:subject:message-id; bh=kLgaqmllmKNEoPT8KkSdoCC7kj+DdGrDcoL6QfU76KA=; b=7S3b+DjY5YBQva6+YSgVQsa22uB6Rj3uPyuLUNr8VssbgZuwJb/abEN7dWypql8P+MEF2keoc weVwL3OLTgqDx5AquVTxmPWwyq1xxyVqvm6sbHhS8rgqT9XMEwXLPWG X-Developer-Key: i=kernel@valentinobst.de; a=ed25519; pk=3s7U8y0mqkaiurgHSQQTYWOo2tw5HgzCg5vnJVfw37Y= X-Endpoint-Received: by B4 Relay for kernel@valentinobst.de/20240131 with auth_id=124 X-Original-From: Valentin Obst Reply-To: X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1789639166914061805 X-GMAIL-MSGID: 1789639166914061805 From: Valentin Obst Convert existing references to C header files to make use of Commit bc2e7d5c298a ("rust: support `srctree`-relative links"). Signed-off-by: Valentin Obst Reviewed-by: Trevor Gross Reviewed-by: Martin Rodriguez Reboredo Reviewed-by: Alice Ryhl --- rust/kernel/lib.rs | 2 +- rust/kernel/sync/condvar.rs | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index b89ecf4e97a0..74581c958a6c 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -78,7 +78,7 @@ pub trait Module: Sized + Sync { /// Equivalent to `THIS_MODULE` in the C API. /// -/// C header: `include/linux/export.h` +/// C header: [`include/linux/export.h`](srctree/include/linux/export.h) pub struct ThisModule(*mut bindings::module); // SAFETY: `THIS_MODULE` may be used from all threads within a module. diff --git a/rust/kernel/sync/condvar.rs b/rust/kernel/sync/condvar.rs index 9f1d83589beb..fa1794972aa0 100644 --- a/rust/kernel/sync/condvar.rs +++ b/rust/kernel/sync/condvar.rs @@ -87,6 +87,8 @@ pub struct CondVar { /// A condvar needs to be pinned because it contains a [`struct list_head`] that is /// self-referential, so it cannot be safely moved once it is initialised. + /// + /// [`struct list_head`]: srctree/include/linux/types.h #[pin] _pin: PhantomPinned, }