pipewire/doc
Peter Hutterer 52bd80aaa4 log: add topic loggers and a default topic
pw_log_log/logv now go through the topic-based logger using the
"default" topic. Log topics themselves can be allocated by the call
sites. The simplest way to use a topic from e.g. a module:

    PW_LOG_TOPIC_STATIC(mod_topic, "mod.foo");
    #define PW_LOG_TOPIC_DEFAULT mod_topic
    ...
    void pipewire__module_init() {
  	  PW_LOG_TOPIC_INIT(mod_topic);
  	  ...
    }

With the #define all pw_log_foo() are now routed through the custom
topic. For the cases where the log topic must be specified, a
pw_logt_foo() set of macros is available.

Log topics are enabled through the PIPEWIRE_DEBUG environment variable
which now supports globs, e.g. PIPEWIRE_DEBUG="*:I;mod.access:D"
to enable global INFO but DEBUG for the access module.

Namespaces documented are "pw", "mod" and "conn", for pipewire-internal
stuff, modules and connection dumping. The latter is special-cased to
avoid spamming the log files, it requires an expcit "conn.<glob>"
pattern to enable.

The "default" topic always exists and is the fallback for any
pw_log_foo() invocation that does not use a topic.
2021-09-28 09:35:38 +02:00
..
api.dox doc: swap two @ doxygen tags for the backslash ones 2021-09-06 07:29:28 +00:00
custom.css doc: move color overrides into light color scheme block 2021-06-15 17:58:06 +00:00
dma-buf.dox doc: add section about v4l2 dmabuf sharing 2021-09-03 09:34:26 +00:00
Doxyfile.in doc: define HAVE_DOT to generate dot files 2021-09-09 13:01:29 +02:00
doxygen-awesome.css doc: add a custom doxygen theme based on doxygen-awesome 2021-05-21 16:08:46 +10:00
index.dox doc: add a reference to the PipeWire Under The Hood post 2021-06-24 10:54:13 +00:00
media-session.dox doc: fix listing of the new No DSP media-session module 2021-09-07 07:52:45 +00:00
meson.build Promote media-session to its own subdirectory 2021-09-22 08:53:08 +02:00
overview.dox doc: move the overview page out to its own page 2021-07-29 14:33:09 +10:00
pipewire-access.dox doc: some more polishing of the access docs 2021-08-02 08:27:51 +00:00
pipewire-architecture.dox doc: switch from .md to .dox files and impose some general structure 2021-05-26 10:02:10 +02:00
pipewire-audio.dox doc: improve the pipewire-audio page for readability 2021-07-29 14:26:01 +10:00
pipewire-daemon.dox log: add topic loggers and a default topic 2021-09-28 09:35:38 +02:00
pipewire-design.dox doc: reword the Design page 2021-07-29 14:43:40 +10:00
pipewire-library.dox doc: move the error reporting blurb to the library page 2021-08-04 07:49:53 +00:00
pipewire-midi.dox doc: better output formatting for the midi page 2021-08-02 08:27:51 +00:00
pipewire-modules.dox doc: expand the module doc a bit 2021-07-30 07:24:24 +00:00
pipewire-objects-design.dox doc: format the objects design page 2021-08-02 08:27:51 +00:00
pipewire-portal.dox doc: document the portal negotation process with graphs 2021-09-06 07:29:28 +00:00
pipewire-session-manager.dox doc: add basic docs for the session manager 2021-08-04 07:49:53 +00:00
pipewire-tools.dox doc: switch from .md to .dox files and impose some general structure 2021-05-26 10:02:10 +02:00
pipewire.dox doc: add DMA-BUF docs 2021-07-29 19:18:49 +00:00
pulseaudio.dox doc: switch from .md to .dox files and impose some general structure 2021-05-26 10:02:10 +02:00
spa-buffer.dox doc: switch the spa documentation to doxygen 2021-05-26 10:02:10 +02:00
spa-design.dox doc: rework the SPA plugin documentation 2021-06-24 10:54:13 +00:00
spa-index.dox doc: rework the SPA plugin documentation 2021-06-24 10:54:13 +00:00
spa-plugins.dox spa: document the spa_interface and how it works 2021-08-05 09:51:40 +00:00
spa-pod.dox doc: switch the spa documentation to doxygen 2021-05-26 10:02:10 +02:00
strip-static.sh doc: add spa to doxygen output 2021-05-26 07:44:55 +00:00
tutorial.dox doc: switch from .md to .dox files and impose some general structure 2021-05-26 10:02:10 +02:00
tutorial1.dox doc: add a meson example to the tutorial 2021-08-05 09:51:40 +00:00
tutorial2.dox doc: change the tutorials to doxygen sources 2021-05-26 10:02:10 +02:00
tutorial3.dox doc: change the tutorials to doxygen sources 2021-05-26 10:02:10 +02:00
tutorial4.dox doc: switch the spa documentation to doxygen 2021-05-26 10:02:10 +02:00
tutorial5.dox doc: switch the spa documentation to doxygen 2021-05-26 10:02:10 +02:00
tutorial6.dox doc: change the tutorials to doxygen sources 2021-05-26 10:02:10 +02:00