linux.git/Documentation/cpu-freq, branch v5.8

docs: cpu-freq: convert cpufreq-stats.txt to ReST

2020-03-05T23:01:02+00:00

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- Adjust some title marks;
- Use bold on some places;
- Mark literal blocks as such;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Rafael J. Wysocki

docs: cpu-freq: convert cpu-drivers.txt to ReST

2020-03-05T23:01:02+00:00

- Add a SPDX header;
- Add a document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- Adjust some title marks;
- Add table markups;
- Add notes markups;
- Mark literal blocks as such;
- use ``foo`` for literal texts;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Rafael J. Wysocki

docs: cpu-freq: convert core.txt to ReST

2020-03-05T23:01:02+00:00

- Add a SPDX header;
- Adjust the  document title, based on the original contents of
  cpu-freq/index.txt;
- Use lists where needed;
- Comment out the existing text-only index;
- use ``foo`` to mark a literal expression with asterisk;
- Adjust some title marks;
- Add table markups;
- Add notes markups;
- Some whitespace fixes and new line breaks;
- Add it to cpu-freq/index.rst.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Rafael J. Wysocki

docs: cpu-freq: convert index.txt to ReST

2020-03-05T23:01:01+00:00

most of the stuff there can be re-used with ReST format,
but we need to add an empty TOC and remove the existing
entries, as the following conversion patches will be re-adding
them, as they're converted.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Rafael J. Wysocki

Documentation: cpufreq: Move legacy driver documentation

2020-03-02T10:31:06+00:00

There are three legacy driver documents in Documentation/cpu-freq/
that were added years ago and converting them each to the .rst
format is rather pointless, even though there is some value in
preserving them.  However, if they are preserved, they need to go
into the admin-guide part of cpufreq documentation where they belong
(at least to a certain extent).

To preserve them with minimum amount of changes and put them into the
right place, and make it possible to process them into HTML (and other
formats) along with the rest of the documentation, move them each
as a "literal text" block into a separate section of a single .rst
"wrapper" file under Documentation/admin-guide/pm/.

While at it, repair the PCC specification URL in one of them.

Signed-off-by: Rafael J. Wysocki

Documentation: cpufreq: Update policy notifier documentation

2019-09-02T20:44:05+00:00

Update documentation with the recent policy notifier updates.

Signed-off-by: Viresh Kumar 
Signed-off-by: Rafael J. Wysocki

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

2019-06-14T21:08:36+00:00

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: Mauro Carvalho Chehab 
Signed-off-by: Bjorn Helgaas 
Acked-by: Mark Brown 
Acked-by: Srivatsa S. Bhat (VMware)

Documentation: cpu-freq: Frequencies aren't always sorted

2018-11-07T12:29:04+00:00

The order in which the frequencies are displayed in cpufreq stats
depends on the order in which the frequencies were sorted in the
frequency table provided to cpufreq core by the cpufreq driver. They can
be completely unsorted as well.

The documentation's claim that the stats will be sorted in descending
order is hence incorrect and here is an attempt to fix it.

Reported-by: Pavel 
Signed-off-by: Viresh Kumar 
Signed-off-by: Rafael J. Wysocki

cpufreq: Drop cpufreq_table_validate_and_show()

2018-04-10T06:40:45+00:00

This isn't used anymore. Remove the helper and update documentation
accordingly.

Signed-off-by: Viresh Kumar 
Signed-off-by: Rafael J. Wysocki

cpufreq: Add and use cpufreq_for_each_{valid_,}entry_idx()

2018-02-08T09:21:39+00:00

Pointer subtraction is slow and tedious. Therefore, replace all instances
where cpufreq_for_each_{valid_,}entry loops contained such substractions
with an iteration macro providing an index to the frequency_table entry.

Suggested-by: Al Viro 
Link: http://lkml.kernel.org/r/20180120020237.GM13338@ZenIV.linux.org.uk
Acked-by: Viresh Kumar 
Signed-off-by: Dominik Brodowski 
Signed-off-by: Rafael J. Wysocki