[PATCH 1/2] ABI: rtc-ab8500: fix rtc_calibration documentation

2016-10-29 Thread Mauro Carvalho Chehab
The "What:" field at the ABI should describe the location of the ABI, e. g. the position under a mounted sysfs. Fix it. Cc: Mark Godfrey Cc: Linus Walleij Cc: Alessandro Zummo Cc: Alexandre Belloni Cc: linux-arm-ker...@lists.infradead.org Cc: rtc-li...@googlegroups.com Signed-off-by: Mauro Ca

[PATCH 2/2] ABI: ibm_rtl: the "What:" fields are incomplete

2016-10-29 Thread Mauro Carvalho Chehab
The "What:" field at the ABI should describe the location of the ABI, e. g. the position under a mounted sysfs. However, this file has only the basename without the path. Fix it. Cc: Vernon Mauery Cc: Darren Hart Cc: platform-driver-...@vger.kernel.org Signed-off-by: Mauro Carvalho Chehab ---

Re: [PATCH 1/2] ABI: rtc-ab8500: fix rtc_calibration documentation

2016-10-29 Thread Linus Walleij
On Sat, Oct 29, 2016 at 12:10 PM, Mauro Carvalho Chehab wrote: > The "What:" field at the ABI should describe the location of > the ABI, e. g. the position under a mounted sysfs. > > Fix it. > > Cc: Mark Godfrey > Cc: Linus Walleij > Cc: Alessandro Zummo > Cc: Alexandre Belloni > Cc: linux-ar

Re: [PATCH 3/3] doc-rst: add an ABI book

2016-10-29 Thread Mauro Carvalho Chehab
Em Fri, 28 Oct 2016 17:57:29 -0400 Greg Kroah-Hartman escreveu: > On Fri, Oct 28, 2016 at 11:33:51AM -0200, Mauro Carvalho Chehab wrote: > > Em Fri, 28 Oct 2016 08:49:12 -0400 > > Greg Kroah-Hartman escreveu: > > > > > On Fri, Oct 28, 2016 at 08:31:57AM -0400, Greg Kroah-Hartman wrote: > >

[PATCH v2 12/19] edac: move documentation from edac_device to edac_core.h

2016-10-29 Thread Mauro Carvalho Chehab
Several functions are documented at edac_device.c. As we'll be including edac_core.h at drivers-api book, move those, in order for the kernel-doc markups be part of the API documentation book. As several of those kernel-doc macros are not in the right format, fix them. Signed-off-by: Mauro Carva

[PATCH v2 17/19] edac: fix kernel-doc tags at the drivers/edac_*.h

2016-10-29 Thread Mauro Carvalho Chehab
Some kernel-doc tags don't provide good descriptions or use a different style. Adjust them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/ras.rst | 2 +- drivers/edac/edac_mc.h| 60 --- 2 files changed, 38 insertions(+), 24 de

[PATCH v2 02/19] edac: edac_core.h: remove prototype for edac_pci_reset_delay_period()

2016-10-29 Thread Mauro Carvalho Chehab
This function doesn't exist. So, remove its prototype. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/edac_core.h | 3 --- 1 file changed, 3 deletions(-) diff --git a/drivers/edac/edac_core.h b/drivers/edac/edac_core.h index 58d66da56486..1723f3643e75 100644 --- a/drivers/edac/edac_core.

[PATCH v2 01/19] edac: edac_core.h: get rid of unused kobj_complete

2016-10-29 Thread Mauro Carvalho Chehab
This element of struct edac_pci_ctl_info is never used. So, get rid of it. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/edac_core.h | 1 - 1 file changed, 1 deletion(-) diff --git a/drivers/edac/edac_core.h b/drivers/edac/edac_core.h index 4861542163d7..58d66da56486 100644 --- a/driver

[PATCH v2 04/19] edac.txt: convert EDAC documentation to ReST

2016-10-29 Thread Mauro Carvalho Chehab
Converts the EDAC driver subsystem documentation to ReST: - Put paragraph titles in lower case; - Add code blocks where needed; - Convert tables to ReST markup; - Mark filesystem and module names as verbatim; - Adjust document to be properly displayed in html. Signed-off-by: Mauro Carvalho Chehab

[PATCH v2 07/19] edac.txt: Improve documentation, adding RAS introduction

2016-10-29 Thread Mauro Carvalho Chehab
The edac.txt assumes that the reader has already deep knowledge on RAS features. However, this may not be the case. So, add an introduction chapter explaining the main concepts that are used by the EDAC subsystem and by other RAS drivers within the Kernel. Signed-off-by: Mauro Carvalho Chehab ---

[PATCH v2 16/19] edac: adjust docs location at MAINTAINERS and 00-INDEX

2016-10-29 Thread Mauro Carvalho Chehab
Update MAINTAINERS and 00-INDEX to reflect the location of edac.rst and ras.rst. Signed-off-by: Mauro Carvalho Chehab --- Documentation/00-INDEX | 4 ++-- MAINTAINERS| 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/00-INDEX b/Documentation/00-INDE

[PATCH v2 09/19] edac: move EDAC PCI definitions to drivers/edac/edac_pci.h

2016-10-29 Thread Mauro Carvalho Chehab
The edac_core.h header contain data structures and function definitions for the 3 parts of EDAC: MC, PCI and device. Let's move the PCI ones to a separate header file, as part of a header reorganization. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/edac_core.h | 145 +-

[PATCH v2 13/19] edac: move documentation from edac_pci*.c to edac_pci.h

2016-10-29 Thread Mauro Carvalho Chehab
Several functions are documented at edac_pci.c and edac_pci_sysfs.c. As we'll be including edac_pci.h at drivers-api book, move those, in order for the kernel-doc markups be part of the API documentation book. As several of those kernel-doc macros are not in the right format, fix them. Signed-of

[PATCH v2 08/19] docs-rst: admin-guide: add documentation for EDAC

2016-10-29 Thread Mauro Carvalho Chehab
EDAC is part of the Kernel's RAS facilities, with is useful for system admins to detect errors. So, add it to the admin's guide. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/index.rst | 2 +- Documentation/{edac.txt => admin-guide/ras.rst} | 0 2 files changed,

[PATCH v2 10/19] edac: move EDAC device definitions to drivers/edac/edac_device.h

2016-10-29 Thread Mauro Carvalho Chehab
The edac_core.h header contain data structures and function definitions for both EDAC MC and EDAC device. Let's move the devices ones to a separate header file, as part of a header reorganization. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/edac_core.h | 238 +-

[PATCH v2 03/19] edac.txt: add a section explaining the dimmX and rankX directories

2016-10-29 Thread Mauro Carvalho Chehab
Documentation for those are missing at the EDAC description. I guess we end by moving such descriptions in the past to the ABI document (or only added it there), but it means that the EDAC documentation is incomplete. So, add it there. Signed-off-by: Mauro Carvalho Chehab --- Documentation/edac

[PATCH v2 05/19] edac.txt: remove info that the Nehalem EDAC is experimental

2016-10-29 Thread Mauro Carvalho Chehab
This driver has been there for almost 3 years, without any conceptual changes. So, it is not experimental anymore, and won't likely have any changes at the API or on log outputs. Signed-off-by: Mauro Carvalho Chehab --- Documentation/edac.txt | 4 1 file changed, 4 deletions(-) diff --git

[PATCH v2 11/19] edac: rename edac_core.h to edac_mc.h

2016-10-29 Thread Mauro Carvalho Chehab
Now, all left at edac_core.h are at drivers/edac/edac_mc.c, so rename it to edac_mc.h. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/altera_edac.c | 1 - drivers/edac/amd64_edac.h | 2 +- drivers/edac/amd76x_edac.c | 2 +- drivers/edac/amd8111_e

[PATCH v2 00/19] Put the EDAC documentation at the Sphinx books

2016-10-29 Thread Mauro Carvalho Chehab
This patch series convert the Documentation/edac.txt book to ReST and add an EDAC documentation to the driver-api book. The first 2 patches on this series are just cleanups to the headers, removing two unused stuff and using -EINVAL instead of -1 on one of the functions. The next 6 patches conve

[PATCH v2 18/19] edac: fix kenel-doc markups at edac.h

2016-10-29 Thread Mauro Carvalho Chehab
As this file was never added to the driver-api, the kernel-doc markups there were never tested. Some of them have issues. Fix them. Signed-off-by: Mauro Carvalho Chehab --- include/linux/edac.h | 40 1 file changed, 24 insertions(+), 16 deletions(-) diff

[PATCH v2 14/19] edac: move documentation from edac_mc.c to edac_core.h

2016-10-29 Thread Mauro Carvalho Chehab
Several functions are documented at edac_mc.c. As we'll be including edac_core.h at drivers-api book, move those, in order for the kernel-doc markups be part of the API documentation book. Signed-off-by: Mauro Carvalho Chehab --- drivers/edac/edac_mc.c | 91

[PATCH v2 19/19] edac.rst: move concepts dictionary from edac.h

2016-10-29 Thread Mauro Carvalho Chehab
Instead of storing the concepts dictionary inside header file, move it to the subsystem documentation. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/edac.rst | 106 + include/linux/edac.h | 108 -

[PATCH v2 06/19] edac.txt: update information about newer Intel CPUs

2016-10-29 Thread Mauro Carvalho Chehab
There's a chapter at edac.rst written by the time Nehalem support was added. Such information is used not only by the Nehalem driver (i7core_edac), but by all newer Intel CPU architectures that are supported by i7core_edac, sb_edac and sbx_edac drivers. Update the information to reflect that. Sig

[PATCH v2 15/19] driver-api: create an edac.rst file with EDAC documentation

2016-10-29 Thread Mauro Carvalho Chehab
Currently, there's no device driver documentation for the EDAC subsystem at the driver-api book. Fill in the blanks for the structures and functions that misses documentation, uniform the word on the existing ones, and add a new edac.rst file at driver-api, in order to document the EDAC subsystem.