Skip to content

RFC kmsg macros, take x+3.

Martin Schwidefsky linux-s390 lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest6 patches 10 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6kmsg: tagged kernel messages.arch/s390/Kconfig include/linux/kmsg.h kernel/printk.c+75 -06 replies
2/6kmsg: tagged device messages.include/linux/device.h kernel/printk.c+57 -223 replies
3/6kmsg: Kernel message catalog script.Makefile scripts/Makefile.build scripts/kmsg-doc+496 -00 replies
4/6kmsg: convert xpram messages to kmsg api.Documentation/kmsg/s390/xpram drivers/s390/block/xpram.c+80 -220 replies
5/6kmsg: convert vmcp to kmsg api.drivers/s390/char/vmcp.c+20 -30 replies
6/6kmsg: convert lcs printk messages to kmsg api.Documentation/kmsg/s390/lcs drivers/s390/net/lcs.c+216 -321 reply

Reviews trailers per patch

1 of 6 patches has a Reviewed-by or Acked-by.

PatchGreg Kroah-Hartman
1/6
2/6A-b
3/6
4/6
5/6
6/6

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [patch 0/6] [RFC] kmsg macros, take x+3.

Greetings,
after a short chat with Greg on the kernel summit here is now the hopefully final version of the kernel message catalog patches. As version x+2 this uses automatically generated message hashes. The new thing is that there are no more special kmsg_dev_xxx macros, this version uses the standard dev_xxx macros. If a KMSG_COMPONENT is defined then dev_xxx will include the message hash after the driver name in the format:

<driver-name>.<message hash>: <device name>: <message>

The problem with finding the correct driver name in the kmsg-doc script has been solved by requiring that the driver name and KMSG_COMPONENT have to match. See patch #2.

To convert a driver to use the message tags you need to do:
1) Add KMSG_COMPONENT to the start of each source file of the driver:
#define KMSG_COMPONENT "driver-name"
The define should be before any of the includes.
2) Replace all normal printks with kmsg_err/kmsg_warn/kmsg_info/.. The dev_xxx printks do not need to be changed in any way.
3) Compile the driver
4) Check for missing messages by running "make D=1 <?.o>" on each of the object files of the driver. For example if I want to check the lcs driver I do "make D=1 drivers/s390/net/lcs.o". Alternatively you can check all object files of your current configuration with just "make D=1". Be prepared that this will take a while..
For each message that misses its documentation you'll get a blueprint.
5) Fill in the ksmg blueprint of the messages and copy the result to either the source file where the respective message is located or to a text file with the component as its name in Documentation/kmsg.
6) Create the man pages your driver with "make D=2 <?.o>".

Greg: could you please comment on patch number #2 if this is ok with you now?

Signature · 4 lines
blue skies,
   Martin.

"Reality continues to ruin my life." - Calvin.