From patchwork Tue Jun 13 18:24:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13279153 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7A88CEB64D7 for ; Tue, 13 Jun 2023 18:25:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240554AbjFMSZ1 (ORCPT ); Tue, 13 Jun 2023 14:25:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58546 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239464AbjFMSYo (ORCPT ); Tue, 13 Jun 2023 14:24:44 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 09A761709; Tue, 13 Jun 2023 11:24:43 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 6530E62F60; Tue, 13 Jun 2023 18:24:41 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 4C47EC433D9; Tue, 13 Jun 2023 18:24:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1686680680; bh=WK1M1XZ0REtusB+Bs/9PHEmAd7saEbfCwi8rA6lQtaw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=MqD8aL5xO0CWMpkkeYW/yEn/4+ZWMtrDpJOPYc0AU818+2mltncssD4pRjLE2v/YE ul1fEqAlvphMYolgDGG9dNXMwTwv+yb6uyT1Jpv7xjDUnrbI3hMNu7NGhviBtdiQl8 eiWkvTmmoNciGcnP3TqkTDEujMewqkeFRiVq+yVsPLkHT7DCokzG9BA8GNHMjIwNH0 SE93O2hrvohcQJ499bLwlKsUGX6e/bFGvSJqT8kXNWjMJNS6rFJrrraKh+Z9noaoPD P4+JcxyVTpuuiTC4hdmAoXL9K4eJOSQt17S27ncIO6i6z1VPi/hIsT8QPEtN5H5o5c aqWzq9WFhO91g== From: SeongJae Park To: paulmck@kernel.org Cc: SeongJae Park , joel@joelfernandes.org, mmpgouride@gmail.com, corbet@lwn.net, rcu@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 3/4] Docs/RCU/rculist_nulls: Fix hlist_head field name of 'obj' Date: Tue, 13 Jun 2023 18:24:33 +0000 Message-Id: <20230613182434.88317-4-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230613182434.88317-1-sj@kernel.org> References: <20230613182434.88317-1-sj@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: rcu@vger.kernel.org The example code snippets on rculist_nulls.rst are assuming 'obj' to have the 'hlist_head' field named 'obj_node', but a sentence is wrongly mentioning 'obj->obj_node.next' as 'obj->obj_next'. Fix it. Signed-off-by: SeongJae Park Reviewed-by: Joel Fernandes (Google) --- Documentation/RCU/rculist_nulls.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/RCU/rculist_nulls.rst b/Documentation/RCU/rculist_nulls.rst index 94a8bfe9f560..5cd6f3f8810f 100644 --- a/Documentation/RCU/rculist_nulls.rst +++ b/Documentation/RCU/rculist_nulls.rst @@ -86,7 +86,7 @@ Quoting Corey Minyard:: 2) Insertion algorithm ---------------------- -We need to make sure a reader cannot read the new 'obj->obj_next' value +We need to make sure a reader cannot read the new 'obj->obj_node.next' value and previous value of 'obj->key'. Otherwise, an item could be deleted from a chain, and inserted into another chain. If new chain was empty before the move, 'next' pointer is NULL, and lockless reader can not