hal/doc/spec hal-spec.xml.in,1.71,1.72

[Richard Hughes]

Update of /cvs/hal/hal/doc/spec
In directory kemper:/tmp/cvs-serv13320/doc/spec

Modified Files:
	hal-spec.xml.in 
Log Message:
2006-05-08  Richard Hughes  <davidz at redhat.com>
 * doc/spec/hal-spec.xml.in: * hald/linux2/osspec.c: (set_suspend_hibernate_keys): Depreciate the keys power_management.can_suspend_to_ram and power_management.can_suspend_to_disk in favour of power_management.can_suspend and power_management.can_hibernate so it's all consistent between the method names and the can_* keys. We'll remove the former keys in a year or so, but leave them now for compatability.


Index: hal-spec.xml.in
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec.xml.in,v
retrieving revision 1.71
retrieving revision 1.72
diff -u -d -r1.71 -r1.72
--- hal-spec.xml.in	26 Apr 2006 15:00:38 -0000	1.71
+++ hal-spec.xml.in	8 May 2006 18:39:32 -0000	1.72
@@ -5101,7 +5101,7 @@
               </entry>
             </row>
             <row>
-              <entry><literal>power_management.can_suspend_to_ram</literal> (bool)</entry>
+              <entry><literal>power_management.can_suspend</literal> (bool)</entry>
               <entry></entry>
               <entry>Yes</entry>
               <entry>
@@ -5111,7 +5111,7 @@
               </entry>
             </row>
             <row>
-              <entry><literal>power_management.can_suspend_to_disk</literal> (bool)</entry>
+              <entry><literal>power_management.can_hibernate</literal> (bool)</entry>
               <entry></entry>
               <entry>Yes</entry>
               <entry>
@@ -5120,6 +5120,73 @@
 		successfully.
               </entry>
             </row>
+            <row>
+              <entry><literal>power_management.can_suspend_to_ram</literal> (bool)</entry>
+              <entry></entry>
+              <entry>No</entry>
+              <entry>
+                If suspend support is compiled into the kernel. 
+		NB. This may not mean the machine is able to suspend
+		successfully.
+		WARNING: This key is depreciated and power_management.can_suspend
+		should be used in its place. This key will be removed, but not before May 1st 2007.
+              </entry>
+            </row>
+            <row>
+              <entry><literal>power_management.can_suspend_to_disk</literal> (bool)</entry>
+              <entry></entry>
+              <entry>No</entry>
+              <entry>
+                If hibernation support is compiled into the kernel. 
+		NB. This may not mean the machine is able to hibernate
+		successfully.
+		WARNING: This key is depreciated and power_management.can_hibernate
+		should be used in its place. This key will be removed, but not before May 1st 2007.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+      <para>
+        The following methods exist on the interface
+        <literal>org.freedesktop.Hal.Device.SystemPowerManagement</literal>.
+      </para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Method (parameter types)</entry>
+              <entry>Parameters</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>Suspend</literal> (integer)</entry>
+              <entry>
+                The number of seconds until we resume automatically, or zero if
+                we should not auto-resume.
+              </entry>
+              <entry>No</entry>
+              <entry>
+                This method puts the system in a state where little power is consumed.
+		The system is not operational while in this state.
+		Latency for the system to return to an operational state is in
+		the order of magnitude of 5 seconds.
+              </entry>
+            </row>
+            <row>
+              <entry><literal>Hibernate</literal> (void)</entry>
+              <entry></entry>
+              <entry>No</entry>
+              <entry>
+                This method puts the system in a state where no power is consumed.
+		The system is not operational while in this state.
+		Latency for the system to return to an operational state is in
+		the order of magnitude of one minute.
+              </entry>
+            </row>
           </tbody>
         </tgroup>
       </informaltable>