NEWS,man: mark systemd-report as experimental

I expect that we'll need to make incompatible changes to
all of this, so let's mark things appropriately.

diff --git a/NEWS b/NEWS
index 3c94a8c7aee6cc02cd17308d33e3966e90136bf4..d3d19896e0197231da6d171ea43fd0ae14894421 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -77,6 +77,10 @@ CHANGES WITH 260 in spe:
           systemd-report is a new command line tool which collects the reports
           from all endpoints and prints them in JSON format.
 
+          The details of the structure of the reports should be considered
+          EXPERIMENTAL at this point. We reserve the right to make incompatible
+          changes to the JSON structure and/or place additional requirements.
+
         Changes in the system and user managers:
 
         * Systemd now uses ANSI CSI 18 sequence to query terminal size. This

diff --git a/man/systemd-report.xml b/man/systemd-report.xml
index c35993372ae7c6d0446d078a2ef141a087584219..f786f0eb72cd67cc6928cb1f8e5213888e2b6e3b 100644 (file)
--- a/man/systemd-report.xml
+++ b/man/systemd-report.xml
@@ -30,6 +30,9 @@
   <refsect1>
     <title>Description</title>
 
+    <para><emphasis>Note: this command is experimental for now. While it is likely to become a regular
+    component of systemd, it might still change in behaviour and interface.</emphasis></para>
+
     <para><command>systemd-report</command> requests facts and metrics from the system and writes them to
     standard output.</para>
   </refsect1>