From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 25 Mar 2025 16:07:36 +0000 (-0400)
Subject: journald: document Varlink interface
X-Git-Tag: v258-rc1~938^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=737bf89ccaa8894af94a9effb2adf7da1d4d100d;p=thirdparty%2Fsystemd.git

journald: document Varlink interface
---

diff --git a/TODO b/TODO
index e4597084ea4..325a96333c3 100644
--- a/TODO
+++ b/TODO
@@ -167,7 +167,6 @@ Features:
 * complete varlink introspection comments:
   - io.systemd.BootControl
   - io.systemd.Hostname
-  - io.systemd.Journal
   - io.systemd.ManagedOOM
   - io.systemd.Network
   - io.systemd.PCRExtend
diff --git a/src/shared/varlink-io.systemd.Journal.c b/src/shared/varlink-io.systemd.Journal.c
index 66514a9d572..ddc36370860 100644
--- a/src/shared/varlink-io.systemd.Journal.c
+++ b/src/shared/varlink-io.systemd.Journal.c
@@ -12,8 +12,14 @@ static SD_VARLINK_DEFINE_ERROR(NotSupportedByNamespaces);
 SD_VARLINK_DEFINE_INTERFACE(
                 io_systemd_Journal,
                 "io.systemd.Journal",
+                SD_VARLINK_INTERFACE_COMMENT("Journal control APIs"),
+                SD_VARLINK_SYMBOL_COMMENT("Write out all pending log messages out to disk, and reply only after that's complete."),
                 &vl_method_Synchronize,
+                SD_VARLINK_SYMBOL_COMMENT("Rotate journal files, i.e. close existing files, start new ones."),
                 &vl_method_Rotate,
+                SD_VARLINK_SYMBOL_COMMENT("Flush runtime logs to persistent logs, i.e. flush log data from /run/ into /var/, and continue writing future log data to the latter location."),
                 &vl_method_FlushToVar,
+                SD_VARLINK_SYMBOL_COMMENT("Relinquish use of /var/ again, return to do runtime logging into /run/ only."),
                 &vl_method_RelinquishVar,
+                SD_VARLINK_SYMBOL_COMMENT("Journal service running as per-namespace instance, and requested operation is not supported for namespaced journal."),
                 &vl_error_NotSupportedByNamespaces);