Received: by 2002:a05:7412:5112:b0:fa:6e18:a558 with SMTP id fm18csp575847rdb; Tue, 23 Jan 2024 08:12:13 -0800 (PST) X-Google-Smtp-Source: AGHT+IEiXa4JWVSAPjVtdFdqmqMJfEypnzg8M/p9I98I0jIVpCWJj98wjVfQqGmv2d4g94cZa5Hi X-Received: by 2002:a2e:9d88:0:b0:2cd:cf7:9b4a with SMTP id c8-20020a2e9d88000000b002cd0cf79b4amr24045ljj.73.1706026333656; Tue, 23 Jan 2024 08:12:13 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706026333; cv=pass; d=google.com; s=arc-20160816; b=aF9H6Huyi7vwmHOwosCVHzjJnlREdgRwGhRGiQ3O40ZvSEp7cEpsWoqY8cUmi91Uwl MV6A3bq70380V/wNDVzaJRq9rM/sGp/CgfED1T3j6Gb4ukw1hKfzLNYIckQVvAss4b/G jsqbNBj1E174IzwwIptOEYKw97sq2uZvGFLkwVAUa/D4qr/K+1RFc/eeV5gWl1F2r9P+ AGIXLOKzRdSeWVDpJd2e4MFLxrMAqmZXuyE+c+d5r+xgr7sO0rVi5lqVoGEFKebXJF7O g3D/48EgOhGdIwVu+Y21uC4Y9P6uXCkIl5XFBO96V87A5u4tRmAtZ0ESU/3FxY2pPBA9 WfGA== 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=Vj0D2otC9fS8GBngZbr7vyupc0N7bNVQqdnANPZiTw4=; fh=BZI9iWTaEf0O3fXVlcMygnOLgsZaFpsfuA9TcLqdYG4=; b=kdlp4ER7ca4nN2J5Tj4k2fSI/3LhVpagxeGk1DmJD7DTMpAnv/zvQKzHHkCpdCLGbN smBOIk+lEI0pWDsMUnGcZp3V8qD5+g+JVSc8QcFv9IGRf9+N3a3vKPVvCRIOILEsj6eH RZS8cCwCsKFlH5vAtppWWybVbFhyLjKQheBZp3RnOaIVeMUL/RbY0uXziW8RCjZxY/l5 S+ta5O5Hm3IvcwB/XPi+6JJ735KySwQYriVuEbh4Ds2iSB8OCWaKNGXGg0eMnyK3ATpJ BSiEl9G1SdD+lSH9mZqIabdyFOeTPfpC5PhmfIDfPRiYu81byUs9tzUE2gG40/npmg/C 5mkw== 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-35632-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35632-linux.lists.archive=gmail.com@vger.kernel.org" Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id l8-20020a50d6c8000000b0055c1c5ae6d2si2926938edj.685.2024.01.23.08.12.13 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 08:12:13 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-35632-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; arc=pass (i=1 spf=pass spfdomain=valentinobst.de); spf=pass (google.com: domain of linux-kernel+bounces-35632-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35632-linux.lists.archive=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 am.mirrors.kernel.org (Postfix) with ESMTPS id 676101F20CD4 for ; Tue, 23 Jan 2024 16:12:13 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 2F4C166B36; Tue, 23 Jan 2024 16:10:32 +0000 (UTC) Received: from mout.kundenserver.de (mout.kundenserver.de [212.227.17.24]) (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 D3AD46BB49; Tue, 23 Jan 2024 16:10:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=212.227.17.24 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706026231; cv=none; b=l6GWyYYns4qo1Me12k29iQ19v6Gyk5cSziTAZzcgCWSKrxRLn8ocSqBzQcFJcAw7yIpdwsstQJu+DPgANioOHZnpbZzuZGy2SaorOJKarBJbFSb97meEt6HpIJkxXCvCPYbQdxEsXCCqYrvh6cUlqbP5bC31WofxgnNFiRTyjkg= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706026231; c=relaxed/simple; bh=/mPIgHq0w2qaUMGCkrU3Cu6bC9EjioKbpcWgTPzL5UI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=n9KDQn2kAzNhHvOl8qG7ZJJotA/lEi7d1JCKOHR6/Iy9r5vWbRTej3q/lRnf4Khsa/npiU7Ysvm8j+nWjCaICZ5GAmCxEYoC4dGaRBEW+A3E7xdvcm+rhGBbNOsKeP4kWFg1H39/gZQo9WqZoUlKfn6CoijcFEtyYrCdBPjgm68= 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=212.227.17.24 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 ([95.223.130.98]) by mrelayeu.kundenserver.de (mreue109 [213.165.67.113]) with ESMTPSA (Nemesis) id 1MdNTy-1qsyXF1lWC-00ZQ6l; Tue, 23 Jan 2024 17:10:21 +0100 From: Valentin Obst To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 12/12] rust: locked_by: shorten doclink preview Date: Tue, 23 Jan 2024 17:10:20 +0100 Message-ID: <20240123161020.125411-1-kernel@valentinobst.de> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240123150112.124084-1-kernel@valentinobst.de> References: <20240123150112.124084-1-kernel@valentinobst.de> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Provags-ID: V03:K1:A78h7VEK/k0EYoCiEAC98WH3nnSRQhqfYYEbV0l8MCjBxERCtaC Dw33gAcdWFNUwuUVkFaKlRJe5jplKvWAuxwWqh0KWV/AgaN50QxkxRiOgBqzkSSVaft2gGG 97wn9jLETO+PUITmJYzOssTtk3EHQski3H25nQeO4XbUmZwHa7k0ywdMUnqUKFttXT3MyOP ShYzJYxLuO2X/z+WtA+gA== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:EDVxGzJZ4fo=;VNkoZV4Qh5i2B3D7njue7EoaVhb uW5IbeOXK9xEDkU2o+nPhw+W3romeRdnBVj5mrbMHxcgaVRDt6h2ypvbaQCUfceyZKZ1JyMOV spOBvIwS0xLmaKzrPZpBL7WK4U3hQzzAp5IgrTxhwwpFoYJu36UaowOjlfWhDeWZ0YKDdrUMM eaALDZiRCDmONzSzb4fij4gFgRiVzICfi29mz4+SKajFB0iSB5lNKdMeclvdKMzK/d/dUtPYM mQGZ78zWP4dhQI2cMjzxW2hXyF+hwkIysCqr4sUAcdxABYjKx0LkSwC9nlFv+jmpcfrZ1SekF 1WP+84mlL+xHLxcQj4xKMts3z5aFdGeqk5zS0S5aGrQQtTY6iBQyo7DqSUR1LohFnUZP7vC9t o14LIg2AYIyAB4kcIzNNLjaQA1FgGn8rZhQeRQBdv8OZn3TgXeQbC+sUuXu3h3J6IJ705XQLS iUnoa3jZmj0zyTG4WdDe1DXh1nkPlF3a0kNOrJa+3CDRj7WyIwftnx5FDuhCr/89x78hamK7l dgI+tsQMGr3Mi9Nz720mD4w9iFFAp+ymychP8+OrB+iZS4LhlIIObIDjnkpBNHgu/OgDWbzbB CCPh0ED9+mL5ufHa8chayac0TzIUV+bshLMgFRX5Ov6aSVQz2cWV0KEo9k57cA9b4ItpaNWLi igeMuNB3sRvzhoIWfZqWZDT07rM61cwWMiGSImlOFpTAyxEYfQU57MnOShrebBuGJduZhavPI XyLd2FPBwuwRUiVZK8ldx2S4cpSdpKTicfariPCBNkRurpYjn20BvEETHM/hWymPP15QDb6Vd Qvdp4QxS+Ye3uK6BclxFy6qXenGE2zWiYJkraCfZ3CksoTBKgRD9NJG9HueYsD/MMmya+sLQ8 s8IOtxGWsjy2C/Q== Increases readability by removing `super::` from the link preview text. Signed-off-by: Valentin Obst Reviewed-by: Trevor Gross Reviewed-by: Martin Rodriguez Reboredo --- 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 -- 2.43.0