From patchwork Wed Jan 17 00:16:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Valentin Obst X-Patchwork-Id: 188652 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:42cf:b0:101:a8e8:374 with SMTP id q15csp603925dye; Tue, 16 Jan 2024 16:17:11 -0800 (PST) X-Google-Smtp-Source: AGHT+IFgQ4OxbuxwEhK5/C2PJKqtrvVP9aqS0p8zDEPWl9RgB9PN6f9+Yhyr424kMcl8njquNPnI X-Received: by 2002:a9d:6c83:0:b0:6dd:ee09:8da4 with SMTP id c3-20020a9d6c83000000b006ddee098da4mr6315716otr.72.1705450630833; Tue, 16 Jan 2024 16:17:10 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1705450630; cv=pass; d=google.com; s=arc-20160816; b=UGMWseNDLcDYLJgVNBCfYPDqKb+XvHkUVzizIAjFjMLHpGofYe/3GkBNinYoRzv8W3 ItJX4zLDEiOOERSYxSTQqOkLkPNHu1LNk/2Vl4nvcDzadf01bc3kicW3Hz0PicfvPFSs AiAeNOODEgTEqIjkHB2JtYAJv5DGG/1iNOhbhq78SUH3vWuxo2utWwduZiZky37ZBQ91 W02DFUF/Tb/dsu1fUC7zTphHBAvjUH6G5GAf5g7nvGL96mxVaDTe7PFr1KjZfZAYq0D/ hXx/Uf1g80cdbnx3R14Hc4pGDMhvvAL/J6fmIRt14Mr0ntUG1Xuo5z+bgR0KluzDnfCP v4Xw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=ui-outboundreport:content-transfer-encoding:mime-version :list-unsubscribe:list-subscribe:list-id:precedence:references :in-reply-to:message-id:date:subject:cc:to:from; bh=eAafLrZMt+IX39xANKceA5pnEILMFrr5Zc9jCJc5ejU=; fh=mB5qiQ7ps5IWvjuQS9+zcxjK3ZInVolb8UwIN1mvAmg=; b=hdThQ/Twyl7Gu1SjuRm8f38jYKopoZxDXJyo91svJ9ApO4sUrq5ImdJJVzSNLfbi8y Pc6gr/eLFTkJ8XELmF2Zfb/vsR+ZBeG3XgfdrGBDq8I6H8M6Mgi3LxhV1zW8paQImIed Q+viDocbSTmChqnhVWJre1fimiNo30J30aPoiJic6nlpRpaLoL6LBBWKGv6ZPWcG8p3C 1vgDu+hyx0GvVQQnRH8EzBeoIVpq4kAWqbEvE2i3ZDTIapsDXGwvGbLQSu4jWLBruSt8 z9s5K2sMUNZpxJolbTnxAmHUnAJ0XF1VKX4h+nku1UTpnMrC9MySyye5SBQp8lzr/IQX rfig== ARC-Authentication-Results: i=2; mx.google.com; arc=pass (i=1 spf=pass spfdomain=valentinobst.de); spf=pass (google.com: domain of linux-kernel+bounces-28393-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-28393-ouuuleilei=gmail.com@vger.kernel.org" Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id p1-20020a0c8c81000000b0067f69d54b26si10380922qvb.572.2024.01.16.16.17.10 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 16:17:10 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-28393-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; arc=pass (i=1 spf=pass spfdomain=valentinobst.de); spf=pass (google.com: domain of linux-kernel+bounces-28393-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-28393-ouuuleilei=gmail.com@vger.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 9B7D71C24B0D for ; Wed, 17 Jan 2024 00:17:10 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 3A49E8F5F; Wed, 17 Jan 2024 00:16:48 +0000 (UTC) Received: from mout.kundenserver.de (mout.kundenserver.de [217.72.192.75]) (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 B653B8468; Wed, 17 Jan 2024 00:16:44 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=217.72.192.75 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705450606; cv=none; b=c24HrX3yuz4SofgVTMt9E8GhRSSuayoJuicx2GnYfa3kuusn8u0jJNKyydHGxsvJf05cYtXGCS2UdDWpMQGvwA0abf4ldKBqt32uQJ+AoiWeAv3fVPWVY5ZjNn7ao/4h/ysIf85I2cjMky9SdAqtFFKRGYqKp6SNIk5j5AQUl6A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705450606; c=relaxed/simple; bh=hvWv/gsA+1XA5/ae14NG4bJ38X5ybqAzDv+NJAAUJFs=; h=Received:From:To:Cc:Subject:Date:Message-ID:X-Mailer:In-Reply-To: References:MIME-Version:Content-Transfer-Encoding:X-Provags-ID: X-Spam-Flag:UI-OutboundReport; b=cwvrSLSkY4nSdNvt7ugnaTLNycZ8DOd6k79Dr/oUEs8cJYzUeCmT0xEAYOfIPFiLn9j3KAPdhAo0GZ1+vHh+HlTWLWf2Qis+VAE9rX/K4qoz9yGz3o4JxPwAB2e+R9y7g73DDT/dtzkmBNaEA4c5hK61LRNWceBfmgPLhpCldRw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=valentinobst.de; spf=pass smtp.mailfrom=valentinobst.de; arc=none smtp.client-ip=217.72.192.75 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=valentinobst.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=valentinobst.de Received: from localhost.localdomain ([217.245.156.100]) by mrelayeu.kundenserver.de (mreue106 [213.165.67.113]) with ESMTPSA (Nemesis) id 1MQdI8-1rkIGR0kJ4-00NlUi; Wed, 17 Jan 2024 01:16:21 +0100 From: Valentin Obst To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho Cc: Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Valentin Obst Subject: [PATCH 13/13] rust: locked_by: shorten doclink preview Date: Wed, 17 Jan 2024 01:16:13 +0100 Message-ID: <20240117001613.169177-1-kernel@valentinobst.de> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240116160141.165951-1-kernel@valentinobst.de> References: <20240116160141.165951-1-kernel@valentinobst.de> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Provags-ID: V03:K1:P+Wtzs9yqXIZYrvFo9hsAvAB2lek5+pAfAMb7c47Q2gbxEq9JQw tZqu5SlmeG69/pBfzK+Ywt2boBTUKjUq/8PDGTdyMbiXg7r7cNU6ZlQYUgSA14R7lUTSVu7 hvLtW6AuECZTB4xDT0D01Iln4xKsWVEeEQdehN6p2+XAupqh0LTaHEGs5tUYWCLq95yMFBh Coc/vrsct7Ow/R0/4SM/A== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:dsSEASkNAtk=;LD2yuxK41OjMV0sSEd4SU39P4y/ OxIG8uPb5vZNU/rpA/U6b+YJw2QI4njvG3acQ47b3Kl3hidgYYuftWvO8hJoBkLSvzQlSMq9k 27EBcoOAShXtSGuMFynffFK8rNZRX5KYOlmraaO/1J8/YOteBQeHimF7mz9quakj9pD7nGkYN KpQLL/gY5mOXnugxEVfRif3JGdPyZl/TcIfl2ogvURVcRGGBNDRFY9eqCARwoAIlKHtdMxHkb dY/rBbo3o4U+wuMADJT2VS5VWXzXqDL70WMl37D1BBMAjEKuA22vB0rUUsnM85lqrISmQuOaq ML9houAAZMW0il42Zw54SmVRMVtqP2o5qXLv+DbR6mx/GLdDnobhXtCaNzLKrIcUwtS7vZVRp QoG41zntmEaKBgkgt19gukKYKQcM/vphyLpPCi9F9dmbK4ivUGIK5mIGYyTYc7D9QotRtUjEj 49EGuYOVFj107ooTaGyiqmvaUYvUmja82EnryQua2nuIbqWC3gHdoIYeQ3IwCMGUm/y2biEMS gl8jzHy+KSPyPPzb6pjS+BUGNncGzELzItuP7F1yJKcTJXpXIQLcJUzn1YhULqbdeRPn7ZvmF oHtDu6hw5aSK2bB+Sjwm9dlHuCjguH2gEniBoyWC9uhOK6X2fyA1qV3NkjhkKO/vEecOrM/XQ gZ3IReFIBCcnGNzorz8EfgQAcpkj1JUrh3z3sqNEI7mjBXr/i99ErjQoSOs9LA78YlH4tvd22 Lk1SAoFl7BrZZFOrCLgZxZckzNcD64Syma1EAmgRK5KyQKMuVM9xo6oX+4wSkfP1JO9IwJkcl pwP5rt3eo4i1326GkspBxuCDsVFPNzyQ1fW6S4+kl6DIe6eW9FD2aFo6zkWagwlqqZIybHiog 0HYV/lU0w7ra7jA== X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788294600532611482 X-GMAIL-MSGID: 1788294600532611482 Increases readability by removing `super::` from the link preview text. Signed-off-by: Valentin Obst Reviewed-by: Trevor Gross --- rust/kernel/sync/locked_by.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rust/kernel/sync/locked_by.rs b/rust/kernel/sync/locked_by.rs index b17ee5cd98f3..22c38993bf63 100644 --- a/rust/kernel/sync/locked_by.rs +++ b/rust/kernel/sync/locked_by.rs @@ -9,7 +9,7 @@ /// Allows access to some data to be serialised by a lock that does not wrap it. /// /// In most cases, data protected by a lock is wrapped by the appropriate lock type, e.g., -/// [`super::Mutex`] or [`super::SpinLock`]. [`LockedBy`] is meant for cases when this is not +/// [`Mutex`] or [`SpinLock`]. [`LockedBy`] is meant for cases when this is not /// possible. For example, if a container has a lock and some data in the contained elements needs /// to be protected by the same lock. /// @@ -17,6 +17,9 @@ /// when the caller shows evidence that the 'external' lock is locked. It panics if the evidence /// refers to the wrong instance of the lock. /// +/// [`Mutex`]: super::Mutex +/// [`SpinLock`]: super::SpinLock +/// /// # Examples /// /// The following is an example for illustrative purposes: `InnerDirectory::bytes_used` is an