Uploaded image for project: 'Core ReactOS'
  1. Core ReactOS
  2. CORE-12671

Improve the format of our debug traces

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Fix Version/s: 0.4.11
    • Component/s: Build System
    • Labels:
      None

      Description

      Currently we use the format:

      <debug_class>:(<file>:<line>) <message>

      example:

      err:(dll/win32/msi/classes.c:999) L"Office.Binder.Wizard.9" has no class

      while Wine uses the format:

      <debug_class>:<channel>:<func> <message>

      example:

      fixme:msi:ITERATE_CreateShortcuts poorly handled shortcut format, advertised shortcut

      Since we import some code from Wine, we (many times) fell into the following:

      FIXME("(%params) message\n", params);

      While, on Wine, this generates something like:

      fixme:<module>:SomeFunc(params) message

      thus, letting the reader directly know which function is involved, on ReactOS this generates instead:

      fixme:(<file>:<line>) (params) message

      making the error message less user-friendly (e.g. could you know in 1 second in which function the message happens?); however it is Testman-friendly since it displays the debug channel ("fixme"), as well as the file and code line in which the problem happens.

      I propose here to improve this situation and incorporate both of the situations, using the following format:

      <debug_class>:(<file>:<line>):<channel>:func <message>

      so that Testman can still use the first two elements of the line (debug_class and file/line), while the user can also focus on the debug channel and function name.

      This would mean "merging" the modifications from r57257 for debug.c and debug.h with the premature revert r62761 . r30441 should also be adapted in consequence.

        Attachments

          Activity

            People

            • Assignee:
              hbelusca hbelusca
              Reporter:
              hbelusca hbelusca
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: