[PATCH] printk: fix kernel-doc name for nbcon_write_context_is_braille

[PATCH] printk: fix kernel-doc name for nbcon_write_context_is_braille

[Muhammad Mahdi Amirpour]

Signed-off-by: Muhammad Mahdi Amirpour <ampr.mhd@gmail.com>
---
 kernel/printk/nbcon.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/printk/nbcon.c b/kernel/printk/nbcon.c
index fb1b37741..6f9735f4b 100644
--- a/kernel/printk/nbcon.c
+++ b/kernel/printk/nbcon.c
@@ -2005,7 +2005,7 @@ void nbcon_kdb_release(struct nbcon_write_context *wctxt)
 }
 
 /**
- * nbcon_is_braille - Checks whether the nbcon write context is using Braille console
+ * nbcon_write_context_is_braille - Checks whether the nbcon write context is using Braille console
  *
  * @wctxt:	checked nbcon write context
  *
-- 
2.55.0

Re: [PATCH] printk: fix kernel-doc name for nbcon_write_context_is_braille

[John Ogness]

On 2026-10-06, Muhammad Mahdi Amirpour <ampr.mhd@gmail.com> wrote:
>

Do we allow empty commit messages? The patch title says it all, so I
guess it is ok.

Now that Linus has pulled the Braille fix, please add:

Fixes: c83e3d291243 ("braille: nbcon: Allow to use a serial console with NBCON API as Braille console")

> Signed-off-by: Muhammad Mahdi Amirpour <ampr.mhd@gmail.com>

...

> diff --git a/kernel/printk/nbcon.c b/kernel/printk/nbcon.c
> index fb1b37741..6f9735f4b 100644
> --- a/kernel/printk/nbcon.c
> +++ b/kernel/printk/nbcon.c
> @@ -2005,7 +2005,7 @@ void nbcon_kdb_release(struct nbcon_write_context *wctxt)
>  }
>  
>  /**
> - * nbcon_is_braille - Checks whether the nbcon write context is using Braille console
> + * nbcon_write_context_is_braille - Checks whether the nbcon write context is using Braille console

Please wrap the comment to 80 columns. You can see
nbcon_device_try_acquire() for an example of a wrapping short
kerneldoc description.

John Ogness

[PATCH v2] printk: fix kernel-doc name for nbcon_write_context_is_braille

[Muhammad Mahdi Amirpour]

Use the function name in the kerneldoc description.

Fixes: c83e3d291243 ("braille: nbcon: Allow to use a serial console with NBCON API as Braille console")
Signed-off-by: Muhammad Mahdi Amirpour <ampr.mhd@gmail.com>
---
 kernel/printk/nbcon.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/kernel/printk/nbcon.c b/kernel/printk/nbcon.c
index fb1b37741..5f8afaca8 100644
--- a/kernel/printk/nbcon.c
+++ b/kernel/printk/nbcon.c
@@ -2005,7 +2005,8 @@ void nbcon_kdb_release(struct nbcon_write_context *wctxt)
 }
 
 /**
- * nbcon_is_braille - Checks whether the nbcon write context is using Braille console
+ * nbcon_write_context_is_braille - Checks whether the nbcon write context
+ *                                  is using Braille console
  *
  * @wctxt:	checked nbcon write context
  *
-- 
2.55.0

Re: [PATCH v2] printk: fix kernel-doc name for nbcon_write_context_is_braille

[John Ogness]

On 2026-10-13, Muhammad Mahdi Amirpour <ampr.mhd@gmail.com> wrote:
> Use the function name in the kerneldoc description.
>
> Fixes: c83e3d291243 ("braille: nbcon: Allow to use a serial console with NBCON API as Braille console")
> Signed-off-by: Muhammad Mahdi Amirpour <ampr.mhd@gmail.com>
> ---
>  kernel/printk/nbcon.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/kernel/printk/nbcon.c b/kernel/printk/nbcon.c
> index fb1b37741..5f8afaca8 100644
> --- a/kernel/printk/nbcon.c
> +++ b/kernel/printk/nbcon.c
> @@ -2005,7 +2005,8 @@ void nbcon_kdb_release(struct nbcon_write_context *wctxt)
>  }
>  
>  /**
> - * nbcon_is_braille - Checks whether the nbcon write context is using Braille console
> + * nbcon_write_context_is_braille - Checks whether the nbcon write context
> + *                                  is using Braille console

Generally we use tabs instead of spaces, but perhaps Petr can fix it up
on commit or maybe he does not care. Either way:

Reviewed-by: John Ogness <john.ogness@linutronix.de>