linux-toradex.git/Documentation/00-INDEX, branch v4.10

edac: adjust docs location at MAINTAINERS and 00-INDEX

2016-12-15T10:57:16+00:00

Update MAINTAINERS to reflect the location of edac.rst and ras.rst.

In the case of 00-INDEX, there's already an entry to the admin-guide,
so all we need to do is to remove the entry there.

Signed-off-by: Mauro Carvalho Chehab

Update Documentation/00-INDEX

2016-12-06T13:13:03+00:00

Em Mon, 5 Dec 2016 14:23:01 -0700
Jonathan Corbet  escreveu:

> On Mon,  5 Dec 2016 09:41:40 -0200
> Mauro Carvalho Chehab  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 
Signed-off-by: Jonathan Corbet

docs: 00-INDEX: document directories/files with no docs

2016-12-05T21:21:42+00:00

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.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: 00-INDEX: remove non-existing entries

2016-12-05T21:21:39+00:00

Several entries were moved to a directory; others got simply
removed. Get rid of those entries.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: 00-INDEX: add missing entries for documentation files/dirs

2016-12-05T21:21:35+00:00

Several directories and individual files don't have entries at
00-INDEX. Add them, using, as reference, the initial text inside
the documentation file(s).

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: 00-INDEX: consolidate process/ and admin-guide/ description

2016-12-05T21:21:29+00:00

Instead of having descriptions for individual files inside
the process/ and admin-guide/ documentation, consolidate them
into one entry per directory, just like other descriptions
inside 00-INDEX.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs-rst: doc-guide: split the kernel-documentation.rst contents

2016-11-19T17:22:04+00:00

Having the kernel-documentation at the topmost level doesn't
allow generating a separate PDF file for it. Also, makes harder
to add extra contents. So, place it on a sub-dir.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

Documentation/00-index: update for new core-api folder

2016-10-28T16:54:51+00:00

Signed-off-by: Silvio Fricke 
Signed-off-by: Jonathan Corbet

Documentation/00-INDEX: remove legacy media directories

2016-10-24T10:12:35+00:00

The dvb/ and video4linux/ dirs were removed, as now, all media
documentation is under media/.

Signed-off-by: Mauro Carvalho Chehab

docs: fix locations of several documents that got moved

2016-10-24T10:12:35+00:00

The previous patch renamed several files that are cross-referenced
along the Kernel documentation. Adjust the links to point to
the right places.

Signed-off-by: Mauro Carvalho Chehab