From 2ed7704e7d4b0086edc8667a80780c6c51ba84cb Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Fri, 22 Oct 2010 23:52:15 -0700 Subject: xsmp.xml: Restore note titles (example/rationale/advice) Signed-off-by: Alan Coopersmith --- doc/xsmp.xml | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/xsmp.xml b/doc/xsmp.xml index 050b8b9..d2a4b5e 100644 --- a/doc/xsmp.xml +++ b/doc/xsmp.xml @@ -177,7 +177,7 @@ A DECnet address would look like this: If multiple network IDs are specified, they should be separated by commas. - + Rationale There was much discussion over whether the XSMP protocol should use X as the transport protocol or whether it should use its own independent @@ -382,7 +382,7 @@ Sequence number. This is a four-digit decimal number. It is incremented every time the session manager creates an ID. After reaching "Q9999" it wraps to "Q0000". - + Rationale Once a client ID has been assigned to the client, the client keeps this ID indefinitely. If the client is terminated and restarted, it @@ -542,7 +542,7 @@ specified, the client should first commit the data to permanent storage before updating its SM properties. - + Examples If a word processor was sent a SaveYourself with a type of Local it could create a temporary file @@ -577,7 +577,7 @@ Once the SM has send SaveYourself to a client, it can't sen - + Advice to Implementors If the client stores local any state in a file or similar "Qexternal" storage, it must create a distinct copy in response to @@ -593,7 +593,7 @@ needed for the new checkpoint. The shutdown field specifies whether the system is being shut down. - + Rationale The interaction may be different depending on whether or not shutdown is set. @@ -628,7 +628,7 @@ message informs the client that all other clients are in a fixed state and this client can save state that is associated with other clients. - + Rationale Clients that manager other clients (window managers, workspace managers, etc) need to know when all clients they are managing are @@ -664,7 +664,7 @@ SM receives this request it may generate a SaveYourself message in response and it may leave the fields intact. - + Example A vendor of a UPS (Uninterruptible Power Supply) might include an SM client that would monitor the status of the UPS and generate a fast shutdown if the power @@ -712,7 +712,8 @@ user. When the client is done interacting with the user it must send an InteractDone message to the SM unless a shutdown cancel is received. - If a client receives a ShutdownCancelled + Advice to Implementors + If a client receives a ShutdownCancelled after receiving an Interact message, but before sending a InteractDone the client should abort the interaction and send a SaveYourselfDone @@ -760,7 +761,7 @@ the client should set the success field to True otherwise the client should set it to False - + Example If a client tries to save its state and runs out of disk space, it should return False in the success field of @@ -837,10 +838,10 @@ this reason to the user. After sending this message, the client must not send any additional XSMP messages to the SM. - + Advice to Implementors If additional messages are received, they should be discarded. - + Rationale The reason for sending the ConnectionClosed message before actually closing the connections is that some transport protocols will not provide immediate notification of connection @@ -2085,7 +2086,7 @@ to RestartAnyway uses this property to specify a command that undoes the effect of the client and removes any saved state. - + Example A user runs xmodmap. xmodmap registers with the SM, sets Restart­Style­Hint to Restart­Anyway and then terminates. In @@ -2150,7 +2151,7 @@ that this is only a hint and the SM will follow the policies specified by its users in determining what applications to restart. - + Rationale This can be specified by a client which supports (as MS-Windows clients do) a means for the user to indicate while exiting that restarting is desired. It can also be used for clients that spawn @@ -2170,7 +2171,7 @@ meant to run continuously. If the client exits, the SM should try to restart it in the current session. - + Advice to Implementors It would be wise to sanity-check the frequency which which RestartImmediately clients are restarted, to avoid a sick client being restarted continuously. @@ -2181,7 +2182,7 @@ The RestartNever style specifies that the client does not wish to be restarted in the next session. - + Advice to Implementors This should be used rarely, if at all. It will cause the client to be silently left out of sessions when they are restarted and will probably be confusing to users. @@ -2199,7 +2200,7 @@ setting RestartStyleHint to RestartAnyway The command must not remove any saved state as the client is still part of the session. - + Example A client is run at start up time that turns on a camera. This client then exits. At session shutdown, the user wants the camera turned off. This client would set the Restart­Style­Hint -- cgit v1.2.1