RFC: KTAP documentation - expected messages

[Frank Rowand <frowand.list@gmail.com>]

Tim Bird started a thread [1] proposing that he document the selftest result
format used by Linux kernel tests.  

[1] https://lore.kernel.org/r/CY4PR13MB1175B804E31E502221BC8163FD830@CY4PR13MB1175.namprd13.prod.outlook.com

The issue of messages generated by the kernel being tested (that are not
messages directly created by the tests, but are instead triggered as a
side effect of the test) came up.  In this thread, I will call these
messages "expected messages".  Instead of sidetracking that thread with
a proposal to handle expected messages, I am starting this new thread.

I implemented an API for expected messages that are triggered by tests
in the Devicetree unittest code, with the expectation that the specific
details may change when the Devicetree unittest code adapts the KUnit
API.  It seems appropriate to incorporate the concept of expected
messages in Tim's documentation instead of waiting to address the
subject when the Devicetree unittest code adapts the KUnit API, since
Tim's document may become the kernel selftest standard.

Instead of creating a very long email containing multiple objects,
I will reply to this email with a separate reply for each of:

  The "expected messages" API implemention and use can be from
  drivers/of/unittest.c in the mainline kernel.

  of_unittest_expect - A proof of concept perl program to filter console
                       output containing expected messages output

                       of_unittest_expect is also available by cloning
                       https://github.com/frowand/dt_tools.git

  An example raw console output with timestamps and expect messages.

  An example of console output processed by filter program
  of_unittest_expect to be more human readable.  The expected
  messages are not removed, but are flagged.

  An example of console output processed by filter program
  of_unittest_expect to be more human readable.  The expected
  messages are removed instead of being flagged.