From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752588AbcLEVZp (ORCPT ); Mon, 5 Dec 2016 16:25:45 -0500 Received: from ms.lwn.net ([45.79.88.28]:38206 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751451AbcLEVZn (ORCPT ); Mon, 5 Dec 2016 16:25:43 -0500 Date: Mon, 5 Dec 2016 14:25:40 -0700 From: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , LKML , Brian Norris Subject: Re: [PATCH 5/5] docs: 00-INDEX: document directories/files with no docs Message-ID: <20161205142540.00aaac51@lwn.net> In-Reply-To: <1a392f2336c5a0421a08fd316e01ca17bb9457d5.1480937715.git.mchehab@s-opensource.com> References: <1a392f2336c5a0421a08fd316e01ca17bb9457d5.1480937715.git.mchehab@s-opensource.com> Organization: LWN.net X-Mailer: Claws Mail 3.14.0 (GTK+ 2.24.31; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, 5 Dec 2016 09:41:45 -0200 Mauro Carvalho Chehab wrote: > There are a number of files/directories that don't contain > any documentation. They're related to ReST file conversion. > > As a matter of completeness, since Makefile is also documented > there, add an entry for those files too. As promised, a couple of quibbles... > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/00-INDEX | 19 +++++++++++++++++++ > 1 file changed, 19 insertions(+) > > diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX > index 272f5c4481f1..6d488509285d 100644 > --- a/Documentation/00-INDEX > +++ b/Documentation/00-INDEX > @@ -14,6 +14,8 @@ Following translations are available on the WWW: > - this file. > ABI/ > - info on kernel <-> userspace ABI and relative interface stability. > +CodingStyle > + - nothing here, just a pointer to process/coding-style.rst. > DMA-API.txt > - DMA API, pci_ API & extensions for non-consistent memory machines. > DMA-API-HOWTO.txt > @@ -39,6 +41,9 @@ Intel-IOMMU.txt > Makefile > - This file does nothing. Removing it breaks make htmldocs and > make distclean. > +Makefile.sphinx > + - This file does nothing. Removing it breaks make htmldocs and > + make distclean. To say that this file "does nothing" is clearly incorrect - it controls how the sphinx build is done. > PCI/ > - info related to PCI drivers. > RCU/ > @@ -47,6 +52,8 @@ SAK.txt > - info on Secure Attention Keys. > SM501.txt > - Silicon Motion SM501 multimedia companion chip > +SubmittingPatches > + - nothing here, just a pointer to process/coding-style.rst. > accounting/ > - documentation on accounting and taskstats. > acpi/ > @@ -93,6 +100,8 @@ clk.txt > - info on the common clock framework > cma/ > - Continuous Memory Area (CMA) debugfs interface. > +conf.py > + - nothing here. Just a configuration file for Sphinx. Again, it's not "nothing"; we could say it's not of interest to people who aren't doing things with the build system. > connector/ > - docs on the netlink based userspace<->kernel space communication mod. > console/ > @@ -135,6 +144,8 @@ digsig.txt > -info on the Digital Signature Verification API > dma-buf-sharing.txt > - the DMA Buffer Sharing API Guide > +docutils.conf > + - nothing here. Just a configuration file for docutils. > dontdiff > - file containing a list of files that should never be diff'ed. > driver-api/ > @@ -201,6 +212,8 @@ ide/ > - Information regarding the Enhanced IDE drive. > iio/ > - info on industrial IIO configfs support. > +index.rst > + - main index for the documentation at ReST format. > infiniband/ > - directory with documents concerning Linux InfiniBand support. > input/ > @@ -307,6 +320,8 @@ nvdimm/ > - info on non-volatile devices. > nvmem/ > - info on non volatile memory framework. > +output/ > + - default directory where html/LaTeX/pdf files will be written. > padata.txt > - An introduction to the "padata" parallel execution API > parisc/ > @@ -387,6 +402,10 @@ sound/ > - directory with info on sound card support. > spi/ > - overview of Linux kernel Serial Peripheral Interface (SPI) support. > +sphinx/ > + - no doumentation here, just files required by Sphinx toolchain. Indeed there's no "doumentation" there :) No documentation either. > +sphinx-static/ > + - no doumentation here, just files required by Sphinx toolchain. > static-keys.txt > - info on how static keys allow debug code in hotpaths via patching > svga.txt Thanks, jon