summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAdam Jackson <ajax@redhat.com>2017-11-20 14:28:13 -0500
committerAdam Jackson <ajax@redhat.com>2018-09-28 16:25:12 -0400
commita23eba2a91024d27da45e5aee1f4215f7ec2ae82 (patch)
treefeca8c7ccfdf82d5fa7a5f588d47e793a21df04b /doc
parentd78ac2f15913bf6f00e06986cc7db0ade9ebd806 (diff)
dix: Merge AbortDDX into ddxGiveUp
These are so close to identical that most DDXes implement one in terms of the other. All the relevant cases can be distinguished by the error code, so merge the functions together to make things simpler. Reviewed-by: Eric Anholt <eric@anholt.net> Signed-off-by: Adam Jackson <ajax@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/Xserver-spec.xml10
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/Xserver-spec.xml b/doc/Xserver-spec.xml
index 3dde65178..a022484ba 100644
--- a/doc/Xserver-spec.xml
+++ b/doc/Xserver-spec.xml
@@ -1316,7 +1316,7 @@ should be terminated with a newline.
</para>
<para>
After printing the message arguments, FatalError() must be implemented
-such that the server will call AbortDDX() to give the ddx layer
+such that the server will call ddxGiveUp(EXIT_ERR_ABORT) to give the ddx layer
a chance to reset the hardware, and then
terminate the server; it must not return.
</para>
@@ -4653,15 +4653,14 @@ An Example implementation is miPushPixels() in Xserver/mi/mipushpxl.c.</para>
<title>Shutdown Procedures</title>
<para>
<blockquote><programlisting>
- void AbortDDX(enum ExitCode error)
void ddxGiveUp(enum ExitCode error)
</programlisting></blockquote>
Some hardware may require special work to be done before the server
exits so that it is not left in an intermediate state. As explained
-in the OS layer, FatalError() will call AbortDDX() just before
+in the OS layer, FatalError() will call ddxGiveUp() just before
terminating the server. In addition, ddxGiveUp() will be called just
-before terminating the server on a "clean" death. What AbortDDX() and
-ddxGiveUP do is left unspecified, only that stubs must exist in the
+before terminating the server on a "clean" death. What
+ddxGiveUp does is left unspecified, only that it must exist in the
ddx layer. It is up to local implementors as to what they should
accomplish before termination.</para>
<section>
@@ -4923,7 +4922,6 @@ mi and fb implementations.</para>
</thead>
<tbody>
<row><entry><function>ALLOCATE_LOCAL</function></entry><entry><literal>os</literal></entry><entry><para></para></entry></row>
-<row><entry><function>AbortDDX</function></entry><entry><literal>hd</literal></entry><entry><para></para></entry></row>
<row><entry><function>AddCallback</function></entry><entry><literal>dix</literal></entry><entry><para></para></entry></row>
<row><entry><function>AddEnabledDevice</function></entry><entry><literal>os</literal></entry><entry><para></para></entry></row>
<row><entry><function>AddInputDevice</function></entry><entry><literal>dix</literal></entry><entry><para></para></entry></row>