Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1536945

Re: [PATCH 0/5] Update Documentation/00-INDEX

Show all headers | View raw

Em Mon, 5 Dec 2016 14:23:01 -0700
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Mon,  5 Dec 2016 09:41:40 -0200
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > So, in order to check it, I wrote a small script that compares the files
> > and directories at Documentation/ with the ones at 00-INDEX.
> > 
> > Then, I synchronized the entries, making the script happy.
> > 
> > We might think on integrating the script with checkpatch.pl, but, as
> > we should get rid of 00-INDEX, it probably not worth the efforts.  
> 
> I would agree with that; I don't see the point of keeping those files
> around in the longer term.
> 
> I've applied the set.  I do have a few quibbles with the final patch that
> I'll send separately, but they're not something to hold this set up for.

Jon,

Did a patch fixing the quibbles.

As it seems you didn't push yet the changeset upstream, feel free to
just fold it with patch 5/5 if you prefer so, or to add as a separate
patch at the end of the series.

Patch enclosed.

Thanks,
Mauro

[PATCH] docs: 00-INDEX: change text related to the building system

Let be clearer on those files related to the build system.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index 6d488509285d..5bd4b07c2f90 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -39,11 +39,9 @@ IRQ.txt
 Intel-IOMMU.txt
 	- basic info on the Intel IOMMU virtualization support.
 Makefile
-	- This file does nothing. Removing it breaks make htmldocs and
-	  make distclean.
+	- It's not of interest for those who aren't touching the build system.
 Makefile.sphinx
-	- This file does nothing. Removing it breaks make htmldocs and
-	  make distclean.
+	- It's not of interest for those who aren't touching the build system.
 PCI/
 	- info related to PCI drivers.
 RCU/
@@ -101,7 +99,7 @@ clk.txt
 cma/
 	- Continuous Memory Area (CMA) debugfs interface.
 conf.py
-	- nothing here. Just a configuration file for Sphinx.
+	- It's not of interest for those who aren't touching the build system.
 connector/
 	- docs on the netlink based userspace<->kernel space communication mod.
 console/
@@ -403,9 +401,9 @@ sound/
 spi/
 	- overview of Linux kernel Serial Peripheral Interface (SPI) support.
 sphinx/
-	- no doumentation here, just files required by Sphinx toolchain.
+	- no documentation here, just files required by Sphinx toolchain.
 sphinx-static/
-	- no doumentation here, just files required by Sphinx toolchain.
+	- no documentation here, just files required by Sphinx toolchain.
 static-keys.txt
 	- info on how static keys allow debug code in hotpaths via patching
 svga.txt

Back to linux.kernel | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

[PATCH 0/5] Update Documentation/00-INDEX Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-05 13:20 +0100
  [PATCH 5/5] docs: 00-INDEX: document directories/files with no docs Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-05 13:20 +0100
    Re: [PATCH 5/5] docs: 00-INDEX: document directories/files with no  docs Jonathan Corbet <corbet@lwn.net> - 2016-12-05 22:30 +0100
      Re: [PATCH 5/5] docs: 00-INDEX: document directories/files with no  docs Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-06 13:50 +0100
  [PATCH 4/5] docs: 00-INDEX: remove non-existing entries Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-05 13:20 +0100
  [PATCH 3/5] docs: 00-INDEX: add missing entries for documentation files/dirs Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-05 13:20 +0100
  [PATCH 2/5] docs: 00-INDEX: consolidate process/ and admin-guide/ description Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-05 13:20 +0100
  Re: [PATCH 0/5] Update Documentation/00-INDEX Jonathan Corbet <corbet@lwn.net> - 2016-12-05 22:30 +0100
    Re: [PATCH 0/5] Update Documentation/00-INDEX Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-12-06 14:00 +0100

csiph-web