public inbox for linux-next@vger.kernel.org 
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail•com>
To: Linux Kernel Mailing List <linux-kernel@vger•kernel.org>,
	Linux Next Mailing List <linux-next@vger•kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation•org>,
	"Rafael J. Wysocki" <rafael@kernel•org>,
	Qi Zheng <zhengqi.arch@bytedance•com>,
	Bagas Sanjaya <bagasdotme@gmail•com>,
	Stephen Rothwell <sfr@canb•auug.org.au>
Subject: [PATCH] debugfs: drop inline constant formatting for ERR_PTR(-ERROR)
Date: Mon, 20 Feb 2023 19:47:21 +0700	[thread overview]
Message-ID: <20230220124721.11657-1-bagasdotme@gmail.com> (raw)

Stephen Rothwell reported htmldocs warning when merging driver-core tree
for linux-next:

Documentation/filesystems/api-summary:146: fs/debugfs/inode.c:804: WARNING: Inline literal start-string without end-string.

The warning is due to inline constant formatting (``%CONST``) doesn't play
nice with complex-name constants like ERR_PTR(-ERROR).

Drop the formatting for that constant above to be consistent with similar
error constants and also to fix the above warning.

Link: https://lore.kernel.org/lkml/20230220163133.481e43d8@canb.auug.org.au/
Fixes: d3002468cb5d5d ("debugfs: update comment of debugfs_rename()")
Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail•com>
---
 fs/debugfs/inode.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/debugfs/inode.c b/fs/debugfs/inode.c
index 58a35afb7c5d89..a7a6a0821605a8 100644
--- a/fs/debugfs/inode.c
+++ b/fs/debugfs/inode.c
@@ -802,7 +802,7 @@ EXPORT_SYMBOL_GPL(debugfs_lookup_and_remove);
  * exist for rename to succeed.
  *
  * This function will return a pointer to old_dentry (which is updated to
- * reflect renaming) if it succeeds. If an error occurs, %ERR_PTR(-ERROR)
+ * reflect renaming) if it succeeds. If an error occurs, ERR_PTR(-ERROR)
  * will be returned.
  *
  * If debugfs is not enabled in the kernel, the value -%ENODEV will be

base-commit: 9f467f6375afd3c7667dbabcfff35c22961e1c0b
-- 
An old man doll... just what I always wanted! - Clara


                 reply	other threads:[~2023-02-20 12:47 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230220124721.11657-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail$(echo .)com \
    --cc=gregkh@linuxfoundation$(echo .)org \
    --cc=linux-kernel@vger$(echo .)kernel.org \
    --cc=linux-next@vger$(echo .)kernel.org \
    --cc=rafael@kernel$(echo .)org \
    --cc=sfr@canb$(echo .)auug.org.au \
    --cc=zhengqi.arch@bytedance$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox