fs: Clarify "non-RCY" in access_override_creds() comment

Message ID 20231031114728.41485-1-bagasdotme@gmail.com
State New
Headers
Series fs: Clarify "non-RCY" in access_override_creds() comment |

Commit Message

Bagas Sanjaya Oct. 31, 2023, 11:47 a.m. UTC
  The term is originally intended as a joke that stands for "non-racy".
This trips new contributors who mistake it for RCU typo [1].

Replace the term with more-explicit wording.

Link: https://lore.kernel.org/r/20231030-debatten-nachrangig-f58abcdac530@brauner/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 fs/open.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


base-commit: 7f680e5f256f346a5d3cd83a17c84bb6bc950008
  

Comments

Christian Brauner Nov. 9, 2023, 9:19 a.m. UTC | #1
On Tue, 31 Oct 2023 18:47:28 +0700, Bagas Sanjaya wrote:
> The term is originally intended as a joke that stands for "non-racy".
> This trips new contributors who mistake it for RCU typo [1].
> 
> Replace the term with more-explicit wording.
> 
> 

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] fs: Clarify "non-RCY" in access_override_creds() comment
      https://git.kernel.org/vfs/vfs/c/effa12a475e6
  

Patch

diff --git a/fs/open.c b/fs/open.c
index 98f6601fbac65e..a89c64629aacf4 100644
--- a/fs/open.c
+++ b/fs/open.c
@@ -442,7 +442,8 @@  static const struct cred *access_override_creds(void)
 	 * 'get_current_cred()' function), that will clear the
 	 * non_rcu field, because now that other user may be
 	 * expecting RCU freeing. But normal thread-synchronous
-	 * cred accesses will keep things non-RCY.
+	 * cred accesses will keep things non-racy to avoid RCU
+	 * freeing.
 	 */
 	override_cred->non_rcu = 1;