From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
LKML <linux-kernel@vger.kernel.org>,
Brian Norris <computersforpeace@gmail.com>
Subject: Re: [PATCH 5/5] docs: 00-INDEX: document directories/files with no docs
Date: Mon, 5 Dec 2016 14:25:40 -0700 [thread overview]
Message-ID: <20161205142540.00aaac51@lwn.net> (raw)
In-Reply-To: <1a392f2336c5a0421a08fd316e01ca17bb9457d5.1480937715.git.mchehab@s-opensource.com>
On Mon, 5 Dec 2016 09:41:45 -0200
Mauro Carvalho Chehab <mchehab@s-opensource.com> 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 <mchehab@s-opensource.com>
> ---
> 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
next prev parent reply other threads:[~2016-12-05 21:25 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-05 11:41 [PATCH 0/5] Update Documentation/00-INDEX Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 1/5] scripts: add a script to check if Documentation/00-INDEX is sane Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 2/5] docs: 00-INDEX: consolidate process/ and admin-guide/ description Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 3/5] docs: 00-INDEX: add missing entries for documentation files/dirs Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 4/5] docs: 00-INDEX: remove non-existing entries Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 5/5] docs: 00-INDEX: document directories/files with no docs Mauro Carvalho Chehab
2016-12-05 21:25 ` Jonathan Corbet [this message]
2016-12-06 12:41 ` Mauro Carvalho Chehab
2016-12-05 21:23 ` [PATCH 0/5] Update Documentation/00-INDEX Jonathan Corbet
2016-12-06 12:51 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161205142540.00aaac51@lwn.net \
--to=corbet@lwn.net \
--cc=computersforpeace@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).