system/systemd
system/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd synced 2024-09-30 05:15:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

bootctl: add comments to Varlink interface

Browse source 
This is mostly intended as test case for the early enum comment bugfix,
as this Varlink IDL description now contains such comments, and
test-varlink-idl will process it forth and back aleady.
This commit is contained in:
Lennart Poettering 2024-06-19 13:54:47 +02:00
parent 9e10f3a7e8
commit 8710bbfe96
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
src/shared/varlink-io.systemd.BootControl.c
View file

@ -4,14 +4,19 @@
static VARLINK_DEFINE_ENUM_TYPE(
BootEntryType,
VARLINK_FIELD_COMMENT("Boot Loader Specification Type #1 entries (.conf files)"),
VARLINK_DEFINE_ENUM_VALUE(type1),
VARLINK_FIELD_COMMENT("Boot Loader Specification Type #2 entries (UKIs)"),
VARLINK_DEFINE_ENUM_VALUE(type2),
VARLINK_FIELD_COMMENT("Additional entries reported by boot loader"),
VARLINK_DEFINE_ENUM_VALUE(loader),
VARLINK_FIELD_COMMENT("Automatically generated entries"),
VARLINK_DEFINE_ENUM_VALUE(auto));
static VARLINK_DEFINE_STRUCT_TYPE(
BootEntry,
VARLINK_DEFINE_FIELD_BY_TYPE(type, BootEntryType, 0),
VARLINK_FIELD_COMMENT("The string identifier of the entry"),
VARLINK_DEFINE_FIELD(id, VARLINK_STRING, VARLINK_NULLABLE),
VARLINK_DEFINE_FIELD(path, VARLINK_STRING, VARLINK_NULLABLE),
VARLINK_DEFINE_FIELD(root, VARLINK_STRING, VARLINK_NULLABLE),
@ -27,22 +32,30 @@ static VARLINK_DEFINE_STRUCT_TYPE(
VARLINK_DEFINE_FIELD(initrd, VARLINK_STRING, VARLINK_NULLABLE|VARLINK_ARRAY),
VARLINK_DEFINE_FIELD(devicetree, VARLINK_STRING, VARLINK_NULLABLE),
VARLINK_DEFINE_FIELD(devicetreeOverlay, VARLINK_STRING, VARLINK_NULLABLE|VARLINK_ARRAY),
VARLINK_FIELD_COMMENT("Indicates whether the boot loader reported this entry on the current boot"),
VARLINK_DEFINE_FIELD(isReported, VARLINK_BOOL, 0),
VARLINK_FIELD_COMMENT("Indicates the number of tries left for this boot entry before it is assumed to be not working."),
VARLINK_DEFINE_FIELD(triesLeft, VARLINK_INT, VARLINK_NULLABLE),
VARLINK_FIELD_COMMENT("Indicates the number of unsuccessful tries already made for this boot entry."),
VARLINK_DEFINE_FIELD(triesDone, VARLINK_INT, VARLINK_NULLABLE),
VARLINK_FIELD_COMMENT("Indicates whether this entry is the default entry."),
VARLINK_DEFINE_FIELD(isDefault, VARLINK_BOOL, VARLINK_NULLABLE),
VARLINK_FIELD_COMMENT("Indicates whether this entry has been booted."),
VARLINK_DEFINE_FIELD(isSelected, VARLINK_BOOL, VARLINK_NULLABLE));
static VARLINK_DEFINE_METHOD(
ListBootEntries,
VARLINK_FIELD_COMMENT("A boot menu entry structure"),
VARLINK_DEFINE_OUTPUT_BY_TYPE(entry, BootEntry, VARLINK_NULLABLE));
static VARLINK_DEFINE_METHOD(
SetRebootToFirmware,
VARLINK_FIELD_COMMENT("The new value of the reboot-to-firmware-UI flag"),
VARLINK_DEFINE_INPUT(state, VARLINK_BOOL, 0));
static VARLINK_DEFINE_METHOD(
GetRebootToFirmware,
VARLINK_FIELD_COMMENT("The current state of the reboot-to-firmware-UI flag"),
VARLINK_DEFINE_OUTPUT(state, VARLINK_BOOL, 0));
static VARLINK_DEFINE_ERROR(
@ -54,10 +67,18 @@ static VARLINK_DEFINE_ERROR(
VARLINK_DEFINE_INTERFACE(
io_systemd_BootControl,
"io.systemd.BootControl",
VARLINK_INTERFACE_COMMENT("Boot Loader control APIs"),
VARLINK_SYMBOL_COMMENT("The type of a boot entry"),
&vl_type_BootEntryType,
VARLINK_SYMBOL_COMMENT("A structure encapsulating a boot entry"),
&vl_type_BootEntry,
VARLINK_SYMBOL_COMMENT("Enumerates boot entries. Method call must be called with 'more' flag set. Each response returns one entry. If no entries are defined returns the NoSuchBootEntry error."),
&vl_method_ListBootEntries,
VARLINK_SYMBOL_COMMENT("Sets the reboot-to-firmware-UI flag of the firmware, if this concept exists. Returns the RebootToFirmwareNotSupported error if not."),
&vl_method_SetRebootToFirmware,
VARLINK_SYMBOL_COMMENT("Gets the current state of the reboot-to-firmware-UI flag of the firmware, if this concept exists. Returns the RebootToFirmwareNotSupported error if not."),
&vl_method_GetRebootToFirmware,
VARLINK_SYMBOL_COMMENT("SetRebootToFirmware() and GetRebootToFirmware() return this if the firmware does not actually support the reboot-to-firmware-UI concept."),
&vl_error_RebootToFirmwareNotSupported,
VARLINK_SYMBOL_COMMENT("No boot entry defined."),
&vl_error_NoSuchBootEntry);