]> Kevux Git Server - fll/commitdiff
Cleanup: Capitalization of wods and improve grammar in documentation.
authorKevin Day <thekevinday@gmail.com>
Mon, 25 Jul 2022 02:59:52 +0000 (21:59 -0500)
committerKevin Day <thekevinday@gmail.com>
Mon, 25 Jul 2022 02:59:52 +0000 (21:59 -0500)
level_3/control/documents/packet_request.txt
level_3/control/documents/packet_response.txt

index 8bf8179bf83de53217c2a9215d70a4ccb90b8d19..c8e8ca56a2a6c251b5ce0b337d215d48f3684c34 100644 (file)
@@ -4,28 +4,28 @@
 #
 
 Packet Request:
-  The control program sends packets and receives packet responses from the controller program over the controller program's control socket.
+  The Control program sends packets and receives packet responses from the Controller program over the Controller program's Control socket.
   This documentation describes the request packets sent by this program.
 
-  The purpose of these request packets are to ask the controller program to perform a requested action.
+  The purpose of these request packets are to ask the Controller program to perform a requested action.
 
-  The communications to/from the controller program utilize the FSS-000F (Simple Packet).
+  The communications to/from the Controller program utilize the FSS-000F (Simple Packet).
   This Simple Packet is expected to contain within it the FSS-000E (Payload) format.
 
   The Payload contains within it a Header and a Payload.
   Note the potential confusion here between the Payload when referring to the Packet format and the Payload referring to the Content within the Payload Packet.
   To avoid this, henceforth "Payload Packet" refers to the FSS-000E (Payload) used within the FSS-000F (Simple Packet).
-  The "Payload Header" refers to eithe the Object ("header:") or Content within the Payload Packet representing the header.
+  The "Payload Header" refers to either the Object ("header:") or Content within the Payload Packet representing the header.
   The "Payload Object" refers to the Object within the Payload Packet (ie: "payload:").
   The "Payload Content" refers to the Content within the Payload Packet.
 
-  The Payload Packet (FSS-000E) is very flexible in what it allows within the Header of the Payload Packet.
+  The FSS-000E (Payload Packet) is very flexible in what it allows within the Header of the Payload Packet.
   The Control program is more restrictive and supports only a subset of the possibilities (which this is explicitly allowed by the Specification).
 
   The Control program only supports the following Payload Packet header Objects for the request\:
-    - type: Allowing only a single type header Object and may only be one of: "controller", "error", or "init".
-    - length: Allowing only a single length header Object and must properly describe the length of the entire Payload Packet as per the referenced Specifications.
-    - action: Allowing only a single action header Object and whose first Content must only be one of: "freeze", "kexec", "kill", "pause", "reboot", "reload", "rerun", "restart", "resume", "shutdown", "start", "stop", and "thaw".
+    - type: Allows only a single type header Object and may only be one of: "controller", "error", or "init".
+    - length: Allows only a single length header Object and must properly describe the length of the entire Payload Packet as per the referenced Specifications.
+    - action: Allows only a single action header Object and whose first Content must only be one of: "freeze", "kexec", "kill", "pause", "reboot", "reload", "rerun", "restart", "resume", "shutdown", "start", "stop", and "thaw".
 
   The number of Content associated with a action are specific to the requirements of that action.
 
index f5dc346e4c54c2e380b7a001a956e15c71c03e10..0287730d582107bcddb5480e49e522bc72dbf31b 100644 (file)
@@ -12,7 +12,7 @@ Packet Response:
 
   The Payload contains within it a Header and a Payload.
   Note the potential confusion here between the Payload when referring to the Packet format and the Payload referring to the Content within the Payload Packet.
-  The "Payload Header" refers to eithe the Object ("header:") or Content within the Payload Packet representing the header.
+  The "Payload Header" refers to either the Object ("header:") or Content within the Payload Packet representing the header.
   The "Payload Object" refers to the Object within the Payload Packet (ie: "payload:").
   The "Payload Content" refers to the Content within the Payload Packet.
 
@@ -20,10 +20,10 @@ Packet Response:
   The Control program is more restrictive and supports only a subset of the possibilities (which this is explicitly allowed by the Specification).
 
   The Control program only supports the following Payload Packet header Objects for the response\:
-    - status: Allowing only a single status header Object.
-    - type: Allowing only a single type header Object and may only be one of: "controller", "error", or "init".
-    - action: Allowing only a single action header Object and must only be one of: "freeze", "kexec", "kill", "pause", "reboot", "reload", "rerun", "restart", "resume", "shutdown", "start", "stop", and "thaw".
-    - length: Allowing only a single length header Object and must properly describe the length of the entire Payload Packet as per the referenced Specifications.
+    - status: Allows only a single status header Object.
+    - type: Allows only a single type header Object and may only be one of: "controller", "error", or "init".
+    - action: Allows only a single action header Object and must only be one of: "freeze", "kexec", "kill", "pause", "reboot", "reload", "rerun", "restart", "resume", "shutdown", "start", "stop", and "thaw".
+    - length: Allows only a single length header Object and must properly describe the length of the entire Payload Packet as per the referenced Specifications.
 
   The "error" type response Payload Packet is treated as an error response.
   For any error responses that are associated with an action, then the action header is provided (otherwise it is not expected and is ignored).