confd: infix-system-software: Add descriptions

src/confd/yang/infix-system-software@2023-06-27.yang

@@ -28,16 +28,22 @@ submodule infix-system-software {
   grouping rauc-stage-log {
     leaf datetime {
       type yang:date-and-time;
+      description
+	"The time of the event.";
     }
 
     leaf count {
       type uint32;
+      description
+	"The total number of occurrences of the event.";
     }
   }
 
   grouping installer-state {
     leaf operation {
       type string;
+      description
+	"The current operation of the installer service.";
     }
 
     container progress {
@@ -54,24 +60,46 @@ submodule infix-system-software {
 
     leaf last-error {
       type string;
+      description
+	"The last error encountered by the installer service.";
     }
   }
 
   augment "/sys:system-state" {
     container software {
+      description
+	"Installed software information
+
+	 Determined by RAUC, which manages all software upgrades.";
+      reference "https://rauc.io/";
+
       leaf compatible {
 	type string;
+	description
+	  "Platform identifier
+
+	   Software bundles' compatible attributes are matched against this
+	   one, to determine if they are compatible with one another.";
       }
 
       leaf variant {
 	type string;
+	description
+	  "Hardware variant
+
+	   Identifies the exact system type.";
       }
 
       leaf booted {
 	type string;
+	description
+	  "Slot from which the system was booted.";
       }
 
       container installer {
+	description
+	  "The current state of the software installer service.";
+
 	uses installer-state;
 
 	// TODO: Support sending notifications during bundle installation
@@ -82,47 +110,73 @@ submodule infix-system-software {
 
       list slot {
 	key "name";
+	description
+	  "Details the installed software and current state of a particular
+	   storage slot (partition).";
 
 	leaf name {
 	  type string;
+	  description
+	    "RAUC's internal name for the slot, in <class>.<id> notation.";
 	}
 
 	leaf bootname {
 	  type string;
+	  description
+	    "Short name of the slot.";
 	}
 
 	leaf class {
 	  type string;
+	  description
+	    "Class of software compatible with the slot.";
 	}
 
 	leaf state {
 	  type string;
+	  description
+	    "The slot's state.";
 	}
 
 	container bundle {
 	  leaf compatible {
 	    type string;
+	    description
+	      "Platform identifier of the installed software image.";
 	  }
 
 	  leaf version {
 	    type string;
+	    description
+	      "Version of the installed software image.";
 	  }
 	}
 
 	leaf size {
 	  type uint64;
+	    description
+	      "Size, in bytes, of the installed software image.";
 	}
 
 	leaf sha256 {
 	  type string {
 	    pattern '[a-fA-F0-9]{64}';
 	  }
+	  description
+	    "Checksum of the installed software image.";
 	}
 	container installed {
+	  description
+	    "Logs the time of the last installation and the total number of
+	     updates to this slot.";
+
 	  uses rauc-stage-log;
 	}
 
 	container activated {
+	  description
+	    "Logs the first time the current slot was activated and the total
+	     number of activations.";
 	  uses rauc-stage-log;
 	}
       }