Re: [PATCH] docs: printk-index: refresh sample index entries

[Jonathan Corbet <corbet@lwn.net>]

Mingzhu Wang <mingzhu.wang@transsion.com> writes:

> From: Mingzhu Wang <mingzhu.wang@transsion.com>
>
> Update the example printk index lines in the User Interface section to
> match the current source code. The previous examples contained stale
> line numbers, an obsolete function name, and incorrect format strings.
>
> - block/blk-settings.c: disk_stack_limits -> queue_limits_stack_bdev,
>   and use %pg instead of %s for the device pointer
> - kernel/trace/trace.c: update line number for trace_create_file()
> - arch/x86/kernel/hpet.c: update line number for _hpet_print_config()
> - init/do_mounts.c: prepare_namespace -> wait_for_root, with updated
>   line number
> - drivers/acpi/osl.c: update line number, include the "OSL:" prefix
>   from pr_fmt(), and fix capitalization of "Auto-serialization"
>
> Signed-off-by: Mingzhu Wang <mingzhu.wang@transsion.com>
> ---
>  Documentation/core-api/printk-index.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/core-api/printk-index.rst b/Documentation/core-api/printk-index.rst
> index 1979c5dd32fe..40023f7dfe98 100644
> --- a/Documentation/core-api/printk-index.rst
> +++ b/Documentation/core-api/printk-index.rst
> @@ -47,11 +47,11 @@ The content is inspired by the dynamic debug interface and looks like::
>  
>     $> head -1 /sys/kernel/debug/printk/index/vmlinux; shuf -n 5 vmlinux
>     # <level[,flags]> filename:line function "format"
> -   <5> block/blk-settings.c:661 disk_stack_limits "%s: Warning: Device %s is misaligned\n"
> -   <4> kernel/trace/trace.c:8296 trace_create_file "Could not create tracefs '%s' entry\n"
> -   <6> arch/x86/kernel/hpet.c:144 _hpet_print_config "hpet: %s(%d):\n"
> -   <6> init/do_mounts.c:605 prepare_namespace "Waiting for root device %s...\n"
> -   <6> drivers/acpi/osl.c:1410 acpi_no_auto_serialize_setup "ACPI: auto-serialization disabled\n"
> +   <5> block/blk-settings.c:955 queue_limits_stack_bdev "%s: Warning: Device %pg is misaligned\n"
> +   <4> kernel/trace/trace.c:7861 trace_create_file "Could not create tracefs '%s' entry\n"
> +   <6> arch/x86/kernel/hpet.c:147 _hpet_print_config "hpet: %s(%d):\n"
> +   <6> init/do_mounts.c:413 wait_for_root "Waiting for root device %s...\n"
> +   <6> drivers/acpi/osl.c:1455 acpi_no_auto_serialize_setup "ACPI: OSL: Auto-serialization disabled\n"

I'm sorry, but this seems like a pointless change.  This is simply
example text, the purpose is to describe how to interpret it, not to
communicate specific messages from a current kernel.  It will always be
out of date, and that doesn't really seem like a problem?

Thanks,

jon