Commit 151f4e2b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Bjorn Helgaas
Browse files

docs: power: convert docs to ReST and rename to *.rst 



Convert the PM documents to ReST, in order to allow them to
build with Sphinx.

The conversion is actually:
  - add blank lines and indentation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Acked-by: default avatarMark Brown <broonie@kernel.org>
Acked-by: default avatarSrivatsa S. Bhat (VMware) <srivatsa@csail.mit.edu>
parent 9595aee2

Documentation/ABI/testing/sysfs-class-powercap

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ Contact: linux-pm@vger.kernel.org 
Description:

		The powercap/ class sub directory belongs to the power cap

		subsystem. Refer to

		Documentation/power/powercap/powercap.txt for details.

		Documentation/power/powercap/powercap.rst for details.



What:		/sys/class/powercap/<control type>

Date:		September 2013

Documentation/admin-guide/kernel-parameters.txt

+3 −3
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ 
			For ARM64, ONLY "acpi=off", "acpi=on" or "acpi=force"

			are available



			See also Documentation/power/runtime_pm.txt, pci=noacpi

			See also Documentation/power/runtime_pm.rst, pci=noacpi



	acpi_apic_instance=	[ACPI, IOAPIC]

			Format: <int>
@@ -223,7 +223,7 @@ 
	acpi_sleep=	[HW,ACPI] Sleep options

			Format: { s3_bios, s3_mode, s3_beep, s4_nohwsig,

				  old_ordering, nonvs, sci_force_enable, nobl }

			See Documentation/power/video.txt for information on

			See Documentation/power/video.rst for information on

			s3_bios and s3_mode.

			s3_beep is for debugging; it makes the PC's speaker beep

			as soon as the kernel's real-mode entry point is called.
@@ -4108,7 +4108,7 @@ 
			Specify the offset from the beginning of the partition

			given by "resume=" at which the swap header is located,

			in <PAGE_SIZE> units (needed only for swap files).

			See  Documentation/power/swsusp-and-swap-files.txt

			See  Documentation/power/swsusp-and-swap-files.rst



	resumedelay=	[HIBERNATION] Delay (in seconds) to pause before attempting to

			read the resume files

Documentation/cpu-freq/core.txt

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ flags - flags of the cpufreq driver 


3. CPUFreq Table Generation with Operating Performance Point (OPP)

==================================================================

For details about OPP, see Documentation/power/opp.txt

For details about OPP, see Documentation/power/opp.rst



dev_pm_opp_init_cpufreq_table -

	This function provides a ready to use conversion routine to translate

Documentation/driver-api/pm/devices.rst

+3 −3
Original line number Diff line number Diff line
@@ -225,7 +225,7 @@ system-wide transition to a sleep state even though its :c:member:`runtime_auto` 
flag is clear.



For more information about the runtime power management framework, refer to

:file:`Documentation/power/runtime_pm.txt`.

:file:`Documentation/power/runtime_pm.rst`.





Calling Drivers to Enter and Leave System Sleep States
@@ -728,7 +728,7 @@ it into account in any way. 


Devices may be defined as IRQ-safe which indicates to the PM core that their

runtime PM callbacks may be invoked with disabled interrupts (see

:file:`Documentation/power/runtime_pm.txt` for more information).  If an

:file:`Documentation/power/runtime_pm.rst` for more information).  If an

IRQ-safe device belongs to a PM domain, the runtime PM of the domain will be

disallowed, unless the domain itself is defined as IRQ-safe. However, it

makes sense to define a PM domain as IRQ-safe only if all the devices in it
@@ -795,7 +795,7 @@ so on) and the final state of the device must reflect the "active" runtime PM 
status in that case.



During system-wide resume from a sleep state it's easiest to put devices into

the full-power state, as explained in :file:`Documentation/power/runtime_pm.txt`.

the full-power state, as explained in :file:`Documentation/power/runtime_pm.rst`.

[Refer to that document for more information regarding this particular issue as

well as for information on the device runtime power management framework in

general.]

Documentation/driver-api/usb/power-management.rst

+1 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ device is turned off while the system as a whole remains running, we 
call it a "dynamic suspend" (also known as a "runtime suspend" or

"selective suspend").  This document concentrates mostly on how

dynamic PM is implemented in the USB subsystem, although system PM is

covered to some extent (see ``Documentation/power/*.txt`` for more

covered to some extent (see ``Documentation/power/*.rst`` for more

information about system PM).



System PM support is present only if the kernel was built with

CRA Git | Maintained and supported by SUSTech CRA and CCSE