Add clarifications, fix indentation

ref #173

Author: jklmnn

src/core/linux/gneiss-broker-main.adb

@@ -97,14 +97,14 @@ is
                Gneiss_Internal.Syscall.Waitpid (B_State.Components (Index).Pid, Exit_Status);
                if Result = SXML.Result_OK then
                   Gneiss_Internal.Print.Info ("Component "
-                                   & XML_Buf (XML_Buf'First .. Last)
-                                   & " exited with status "
-                                   & Basalt.Strings.Image (Exit_Status));
+                                              & XML_Buf (XML_Buf'First .. Last)
+                                              & " exited with status "
+                                              & Basalt.Strings.Image (Exit_Status));
                else
                   Gneiss_Internal.Print.Info ("Component PID "
-                                   & Basalt.Strings.Image (B_State.Components (Index).Pid)
-                                   & " exited with status "
-                                   & Basalt.Strings.Image (Exit_Status));
+                                              & Basalt.Strings.Image (B_State.Components (Index).Pid)
+                                              & " exited with status "
+                                              & Basalt.Strings.Image (Exit_Status));
                end if;
                if Gneiss_Internal.Valid (B_State.Components (Index).Fd) then
                   Gneiss_Internal.Epoll.Remove (B_State.Epoll_Fd, B_State.Components (Index).Fd, Ignore_Success);

src/core/linux/gneiss-broker-startup.adb

@@ -60,7 +60,7 @@ is
                   pragma Warnings (On, "unused assignment to ""Fd""");
                   Parent := True;
                   Gneiss_Internal.Print.Info ("Started " & XML_Buf (XML_Buf'First .. Last)
-                                            & " with PID " & Basalt.Strings.Image (Pid));
+                                              & " with PID " & Basalt.Strings.Image (Pid));
                else --  Pid = 0, Child
                   Gneiss_Internal.Syscall.Close (State.Epoll_Fd);
                   Load (State, Fd, Query, Status);

src/log/genode/gneiss-log.adb

@@ -25,6 +25,6 @@ is
    function Index (Session : Dispatcher_Session) return Session_Index_Option is
       (Session.Index);
 
-   function Registered (Session : Dispatcher_Session) return Boolean is (True);
+   function Registered (Session : Dispatcher_Session) return Boolean is (False);
 
 end Gneiss.Log;

src/log/server/linux/gneiss-log-dispatcher.adb

@@ -82,6 +82,10 @@ is
                                            Label.Value (Label.Value'First .. Label.Last));
          end if;
       else
+         --  If Fd /= Dispatch_Fd a server session has been closed by a client. So
+         --  Dispatch will be called with an invalid capability that carries the
+         --  file descriptor as Clean_Fd which is then used to clean up the disconnected
+         --  session in Session_Cleanup.
          Dispatch (Session,
                    Dispatcher_Capability'(Client_Fd => -1,
                                           Server_Fd => -1,

src/memory/genode/gneiss-memory.adb

@@ -30,6 +30,6 @@ is
    function Index (Session : Dispatcher_Session) return Session_Index_Option is
       (Session.Index);
 
-   function Registered (Session : Dispatcher_Session) return Boolean is (True);
+   function Registered (Session : Dispatcher_Session) return Boolean is (False);
 
 end Gneiss.Memory;

src/memory/server/linux/gneiss-memory-dispatcher.adb

@@ -72,6 +72,10 @@ is
                                            Label.Value (Label.Value'First .. Label.Last));
          end if;
       else
+         --  If Fd /= Dispatch_Fd a server session has been closed by a client. So
+         --  Dispatch will be called with an invalid capability that carries the
+         --  file descriptor as Clean_Fd which is then used to clean up the disconnected
+         --  session in Session_Cleanup.
          Dispatch (Session,
                    Dispatcher_Capability'(Memfd     => -1,
                                           Client_Fd => -1,

src/message/genode/gneiss-message.adb

@@ -30,6 +30,6 @@ is
    function Index (Session : Dispatcher_Session) return Session_Index_Option is
       (Session.Index);
 
-   function Registered (Session : Dispatcher_Session) return Boolean is (True);
+   function Registered (Session : Dispatcher_Session) return Boolean is (False);
 
 end Gneiss.Message;

src/message/server/linux/gneiss-message-dispatcher.adb

@@ -105,6 +105,10 @@ is
                                            Label.Value (Label.Value'First .. Label.Last));
          end if;
       else
+         --  If Fd /= Dispatch_Fd a server session has been closed by a client. So
+         --  Dispatch will be called with an invalid capability that carries the
+         --  file descriptor as Clean_Fd which is then used to clean up the disconnected
+         --  session in Session_Cleanup.
          Dispatch (Session,
                    Dispatcher_Capability'(Client_Fd => -1,
                                           Server_Fd => -1,

test/log_proxy/component.adb

@@ -260,8 +260,8 @@ is
          Flush (S);
       else
          declare
+            -- WORKAROUND: Componolit/Workarounds#25
             Clr : constant String := Get_Color (S.Hue);
-            --  Separate declaration: non-scalar object declared before loop-invariant is not yet supported
          begin
             for H of Clr loop
                pragma Loop_Invariant (Log.Initialized (Client));

test/message_client/component.adb

@@ -22,9 +22,9 @@ is
                             Gneiss_Internal.Platform_State,
                             Main.Platform));
 
-   function Null_Terminate (S : String) return String with
-      Post   => Null_Terminate'Result'First = S'First
-                and then Null_Terminate'Result'Length <= S'Length,
+   function Strip (S : String) return String with
+      Post   => Strip'Result'First = S'First
+                and then Strip'Result'Length <= S'Length,
       Global => null;
 
    package Message is new Gneiss.Message (Message_Buffer, Null_Buffer);
@@ -35,7 +35,7 @@ is
    Log        : Gneiss_Log.Client_Session;
    Capability : Gneiss.Capability;
 
-   function Null_Terminate (S : String) return String
+   function Strip (S : String) return String
    is
    begin
       for I in S'Range loop
@@ -44,7 +44,7 @@ is
          end if;
       end loop;
       return S;
-   end Null_Terminate;
+   end Strip;
 
    procedure Construct (Cap : Gneiss.Capability)
    is
@@ -55,7 +55,7 @@ is
       Message_Client.Initialize (Client, Capability, "log");
       if Gneiss_Log.Initialized (Log) and Message.Initialized (Client) then
          Msg (Msg'First .. Msg'First + 11) := "Hello World!";
-         Log_Client.Info (Log, "Sending: " & Null_Terminate (Msg));
+         Log_Client.Info (Log, "Sending: " & Strip (Msg));
          Message_Client.Write (Client, Msg);
       else
          Main.Vacate (Capability, Main.Failure);
@@ -71,7 +71,7 @@ is
             pragma Loop_Invariant (Gneiss_Log.Initialized (Log));
             pragma Loop_Invariant (Message.Initialized (Client));
             Message_Client.Read (Client, Msg);
-            Log_Client.Info (Log, "Received: " & Null_Terminate (Msg));
+            Log_Client.Info (Log, "Received: " & Strip (Msg));
             Main.Vacate (Capability, Main.Success);
          end loop;
       end if;