linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/4] docs: driver-api: edid: Fix list formatting
@ 2020-02-14 17:41 Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 2/4] docs: admin-guide: Move edid.rst from driver-api Jonathan Neuschäfer
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Jonathan Neuschäfer @ 2020-02-14 17:41 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Corbet, Jonathan Neuschäfer, Mauro Carvalho Chehab,
	Cornelia Huck, Logan Gunthorpe, Andy Shevchenko,
	Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, Greg Kroah-Hartman,
	Jason Gunthorpe, Harald Seiler, linux-kernel

Without the empty lines, Sphinx renders the list as part of the running
text.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/driver-api/edid.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/driver-api/edid.rst b/Documentation/driver-api/edid.rst
index b1b5acd501ed..7dc07942ceb2 100644
--- a/Documentation/driver-api/edid.rst
+++ b/Documentation/driver-api/edid.rst
@@ -11,11 +11,13 @@ Today, with the advent of Kernel Mode Setting, a graphics board is
 either correctly working because all components follow the standards -
 or the computer is unusable, because the screen remains dark after
 booting or it displays the wrong area. Cases when this happens are:
+
 - The graphics board does not recognize the monitor.
 - The graphics board is unable to detect any EDID data.
 - The graphics board incorrectly forwards EDID data to the driver.
 - The monitor sends no or bogus EDID data.
 - A KVM sends its own EDID data instead of querying the connected monitor.
+
 Adding the kernel parameter "nomodeset" helps in most cases, but causes
 restrictions later on.

--
2.20.1


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 2/4] docs: admin-guide: Move edid.rst from driver-api
  2020-02-14 17:41 [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Neuschäfer
@ 2020-02-14 17:41 ` Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 3/4] tools/edid: Move EDID data sets from Documentation/ Jonathan Neuschäfer
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Neuschäfer @ 2020-02-14 17:41 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Corbet, Jonathan Neuschäfer, Mauro Carvalho Chehab,
	Cornelia Huck, Logan Gunthorpe, Andy Shevchenko,
	Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, Greg Kroah-Hartman,
	Jason Gunthorpe, Harald Seiler, linux-kernel, Darrick J. Wong

This document describes actions that an admin can do, rather than
interfaces available to driver developers, so admin-guide seems to
be a more appropriate place for it.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/{driver-api => admin-guide}/edid.rst | 0
 Documentation/admin-guide/index.rst                | 1 +
 Documentation/driver-api/index.rst                 | 1 -
 3 files changed, 1 insertion(+), 1 deletion(-)
 rename Documentation/{driver-api => admin-guide}/edid.rst (100%)

diff --git a/Documentation/driver-api/edid.rst b/Documentation/admin-guide/edid.rst
similarity index 100%
rename from Documentation/driver-api/edid.rst
rename to Documentation/admin-guide/edid.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index f1d0ccffbe72..5a6269fb8593 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -75,6 +75,7 @@ configure specific aspects of kernel behavior to your liking.
    cputopology
    dell_rbu
    device-mapper/index
+   edid
    efi-stub
    ext4
    nfs/index
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 0ebe205efd0c..ea3003b3c5e5 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -74,7 +74,6 @@ available subsections can be seen below.
    connector
    console
    dcdbas
-   edid
    eisa
    ipmb
    isa
--
2.20.1


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 3/4] tools/edid: Move EDID data sets from Documentation/
  2020-02-14 17:41 [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 2/4] docs: admin-guide: Move edid.rst from driver-api Jonathan Neuschäfer
@ 2020-02-14 17:41 ` Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 4/4] docs: admin-guide: edid: Clarify where to run "make" Jonathan Neuschäfer
  2020-02-19 11:11 ` [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Neuschäfer @ 2020-02-14 17:41 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Corbet, Jonathan Neuschäfer, Mauro Carvalho Chehab,
	Cornelia Huck, Logan Gunthorpe, Andy Shevchenko,
	Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, Greg Kroah-Hartman,
	Jason Gunthorpe, Harald Seiler, linux-kernel

The EDID files are not really documentation.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 {Documentation/EDID => tools/edid}/1024x768.S  | 0
 {Documentation/EDID => tools/edid}/1280x1024.S | 0
 {Documentation/EDID => tools/edid}/1600x1200.S | 0
 {Documentation/EDID => tools/edid}/1680x1050.S | 0
 {Documentation/EDID => tools/edid}/1920x1080.S | 0
 {Documentation/EDID => tools/edid}/800x600.S   | 0
 {Documentation/EDID => tools/edid}/Makefile    | 0
 {Documentation/EDID => tools/edid}/edid.S      | 0
 {Documentation/EDID => tools/edid}/hex         | 0
 9 files changed, 0 insertions(+), 0 deletions(-)
 rename {Documentation/EDID => tools/edid}/1024x768.S (100%)
 rename {Documentation/EDID => tools/edid}/1280x1024.S (100%)
 rename {Documentation/EDID => tools/edid}/1600x1200.S (100%)
 rename {Documentation/EDID => tools/edid}/1680x1050.S (100%)
 rename {Documentation/EDID => tools/edid}/1920x1080.S (100%)
 rename {Documentation/EDID => tools/edid}/800x600.S (100%)
 rename {Documentation/EDID => tools/edid}/Makefile (100%)
 rename {Documentation/EDID => tools/edid}/edid.S (100%)
 rename {Documentation/EDID => tools/edid}/hex (100%)

diff --git a/Documentation/EDID/1024x768.S b/tools/edid/1024x768.S
similarity index 100%
rename from Documentation/EDID/1024x768.S
rename to tools/edid/1024x768.S
diff --git a/Documentation/EDID/1280x1024.S b/tools/edid/1280x1024.S
similarity index 100%
rename from Documentation/EDID/1280x1024.S
rename to tools/edid/1280x1024.S
diff --git a/Documentation/EDID/1600x1200.S b/tools/edid/1600x1200.S
similarity index 100%
rename from Documentation/EDID/1600x1200.S
rename to tools/edid/1600x1200.S
diff --git a/Documentation/EDID/1680x1050.S b/tools/edid/1680x1050.S
similarity index 100%
rename from Documentation/EDID/1680x1050.S
rename to tools/edid/1680x1050.S
diff --git a/Documentation/EDID/1920x1080.S b/tools/edid/1920x1080.S
similarity index 100%
rename from Documentation/EDID/1920x1080.S
rename to tools/edid/1920x1080.S
diff --git a/Documentation/EDID/800x600.S b/tools/edid/800x600.S
similarity index 100%
rename from Documentation/EDID/800x600.S
rename to tools/edid/800x600.S
diff --git a/Documentation/EDID/Makefile b/tools/edid/Makefile
similarity index 100%
rename from Documentation/EDID/Makefile
rename to tools/edid/Makefile
diff --git a/Documentation/EDID/edid.S b/tools/edid/edid.S
similarity index 100%
rename from Documentation/EDID/edid.S
rename to tools/edid/edid.S
diff --git a/Documentation/EDID/hex b/tools/edid/hex
similarity index 100%
rename from Documentation/EDID/hex
rename to tools/edid/hex
--
2.20.1


^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH 4/4] docs: admin-guide: edid: Clarify where to run "make"
  2020-02-14 17:41 [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 2/4] docs: admin-guide: Move edid.rst from driver-api Jonathan Neuschäfer
  2020-02-14 17:41 ` [PATCH 3/4] tools/edid: Move EDID data sets from Documentation/ Jonathan Neuschäfer
@ 2020-02-14 17:41 ` Jonathan Neuschäfer
  2020-02-19 11:11 ` [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Neuschäfer @ 2020-02-14 17:41 UTC (permalink / raw)
  To: linux-doc
  Cc: Jonathan Corbet, Jonathan Neuschäfer, Mauro Carvalho Chehab,
	Cornelia Huck, Logan Gunthorpe, Andy Shevchenko,
	Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, Greg Kroah-Hartman,
	Jason Gunthorpe, Harald Seiler, linux-kernel

When both the documentation and the data files lived in
Documentation/EDID, this wasn't necessary, but both have
been moved to other directories in the meantime.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/admin-guide/edid.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/edid.rst b/Documentation/admin-guide/edid.rst
index 7dc07942ceb2..80deeb21a265 100644
--- a/Documentation/admin-guide/edid.rst
+++ b/Documentation/admin-guide/edid.rst
@@ -34,7 +34,7 @@ individual data for a specific misbehaving monitor, commented sources
 and a Makefile environment are given here.

 To create binary EDID and C source code files from the existing data
-material, simply type "make".
+material, simply type "make" in tools/edid/.

 If you want to create your own EDID file, copy the file 1024x768.S,
 replace the settings with your own data and add a new target to the
--
2.20.1


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/4] docs: driver-api: edid: Fix list formatting
  2020-02-14 17:41 [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Neuschäfer
                   ` (2 preceding siblings ...)
  2020-02-14 17:41 ` [PATCH 4/4] docs: admin-guide: edid: Clarify where to run "make" Jonathan Neuschäfer
@ 2020-02-19 11:11 ` Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2020-02-19 11:11 UTC (permalink / raw)
  To: Jonathan Neuschäfer
  Cc: linux-doc, Mauro Carvalho Chehab, Cornelia Huck, Logan Gunthorpe,
	Andy Shevchenko, Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, Greg Kroah-Hartman,
	Jason Gunthorpe, Harald Seiler, linux-kernel

On Fri, 14 Feb 2020 18:41:32 +0100
Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:

> Without the empty lines, Sphinx renders the list as part of the running
> text.
> 
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>

I've applied this (and the rest of the set as well).

Thanks,

jon

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2020-02-19 11:11 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-14 17:41 [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Neuschäfer
2020-02-14 17:41 ` [PATCH 2/4] docs: admin-guide: Move edid.rst from driver-api Jonathan Neuschäfer
2020-02-14 17:41 ` [PATCH 3/4] tools/edid: Move EDID data sets from Documentation/ Jonathan Neuschäfer
2020-02-14 17:41 ` [PATCH 4/4] docs: admin-guide: edid: Clarify where to run "make" Jonathan Neuschäfer
2020-02-19 11:11 ` [PATCH 1/4] docs: driver-api: edid: Fix list formatting Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).