DUNE-DAQ / DUNE-DAQ/logging

Think about defining `LOG_DECLARE_ISSUE` macros in Logging.hpp

Open
#41 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
Avg merge
30m
Merged PRs (30d)
1

Description

Since #include "logging/Logging.hpp" must be visible to translation units before ERS_DECLARE_ISSUE is called, it may be a good idea to define macros in Logging.hpp of the following form:

#define LOG_DECLARE_ISSUE(...) ERS_DECLARE_ISSUE(va_args)
#define LOG_DECLARE_ISSUE_BASE(...) ERS_DECLARE_ISSUE_BASE(va_args)
...

The idea would be that everything then uses a "logging-style" interface, and reduce confusion about what needs to be included to make ers::Issue classes.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with logging/Logging.hpp and inspect the existing ERS_DECLARE_ISSUE and ERS_DECLARE_ISSUE_BASE usage. Determine which logging-style macro forms are needed and how their arguments should forward to the ERS macros. Done means issue declarations can use the proposed logging interface without requiring callers to include the ERS header separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.