pcrextend: add documentation for varlink api

diff --git a/TODO b/TODO
index 58edfc13169218da933f28ce641c6b05b1af066c..0aa861c9188cfcf18e8e78853aaba351587fbb35 100644 (file)
--- a/TODO
+++ b/TODO
@@ -245,7 +245,6 @@ Features:
   - io.systemd.Hostname
   - io.systemd.ManagedOOM
   - io.systemd.Network
-  - io.systemd.PCRExtend
   - io.systemd.PCRLock
   - io.systemd.Resolve.Monitor
   - io.systemd.Resolve

diff --git a/src/shared/varlink-io.systemd.PCRExtend.c b/src/shared/varlink-io.systemd.PCRExtend.c
index 956a0eacca7ac5949d77c54e7e1962f66a4cd400..d104fc0853b3f9c1159cfdba0a89644f6ecb9d0d 100644 (file)
--- a/src/shared/varlink-io.systemd.PCRExtend.c
+++ b/src/shared/varlink-io.systemd.PCRExtend.c
@@ -4,11 +4,16 @@
 
 static SD_VARLINK_DEFINE_METHOD(
                 Extend,
+                SD_VARLINK_FIELD_COMMENT("PCR number to extend, in range of 0…23"),
                 SD_VARLINK_DEFINE_INPUT(pcr, SD_VARLINK_INT, 0),
+                SD_VARLINK_FIELD_COMMENT("Text string to measure. (Specify either this, or the 'data' field below, not both)"),
                 SD_VARLINK_DEFINE_INPUT(text, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
+                SD_VARLINK_FIELD_COMMENT("Binary data to measure, encoded in Base64. (Specify either this, or the 'text' field above, not both)"),
                 SD_VARLINK_DEFINE_INPUT(data, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
 
 SD_VARLINK_DEFINE_INTERFACE(
                 io_systemd_PCRExtend,
                 "io.systemd.PCRExtend",
+                SD_VARLINK_INTERFACE_COMMENT("TPM PCR Extension APIs"),
+                SD_VARLINK_SYMBOL_COMMENT("Measure some text or binary data into a PCR"),
                 &vl_method_Extend);