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

2016-11-02 Thread Borislav Petkov
On Sat, Oct 29, 2016 at 04:33:58PM -0200, Mauro Carvalho Chehab wrote:
> 
> 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 convert Documentation/edac.txt to ReST, improve
> it and rename to ras.rst, moving  it to the admin-guide.
> 
> The remaining patches move existing documentation to edac_mc.h,
> edac_device.h and edac_pci.h, improving the documentation provided
> on them in order to be properly parsed by kernel-doc script.
> 
> Regards,
> Mauro
> 
> - version 2:
>   - don't change the return code for edac_mc_find_csrow_by_page();
>   - split edac_core.h into 3 headers, one per each EDAC API
> (memory controller, PCI and device);
>   - add linux/include/edac.h at the driver-api book.

Looks ok to me at a quick glance.

Thanks.

-- 
Regards/Gruss,
Boris.

ECO tip #101: Trim your mails when you reply.
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[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 convert Documentation/edac.txt to ReST, improve
it and rename to ras.rst, moving  it to the admin-guide.

The remaining patches move existing documentation to edac_mc.h,
edac_device.h and edac_pci.h, improving the documentation provided
on them in order to be properly parsed by kernel-doc script.

Regards,
Mauro

- version 2:
  - don't change the return code for edac_mc_find_csrow_by_page();
  - split edac_core.h into 3 headers, one per each EDAC API
(memory controller, PCI and device);
  - add linux/include/edac.h at the driver-api book.

NOTE: Originally, I was wanting to break the edac_core.h into 6 headers,
adding one header also for the edac_*_sysfs.c files. However, at the
end, it will be too messy, as the sysfs data structures should be embedded
at the structures inside edac_mc.h, edac_pci.h and edac_device.h. I might
have added only the function calls on at the edac_*_sysfs.h, but that would
mean to include just two functions for each.

Mauro Carvalho Chehab (19):
  edac: edac_core.h: get rid of unused kobj_complete
  edac: edac_core.h: remove prototype for edac_pci_reset_delay_period()
  edac.txt: add a section explaining the dimmX and rankX directories
  edac.txt: convert EDAC documentation to ReST
  edac.txt: remove info that the Nehalem EDAC is experimental
  edac.txt: update information about newer Intel CPUs
  edac.txt: Improve documentation, adding RAS introduction
  docs-rst: admin-guide: add documentation for EDAC
  edac: move EDAC PCI definitions to drivers/edac/edac_pci.h
  edac: move EDAC device definitions to drivers/edac/edac_device.h
  edac: rename edac_core.h to edac_mc.h
  edac: move documentation from edac_device to edac_core.h
  edac: move documentation from edac_pci*.c to edac_pci.h
  edac: move documentation from edac_mc.c to edac_core.h
  driver-api: create an edac.rst file with EDAC documentation
  edac: adjust docs location at MAINTAINERS and 00-INDEX
  edac: fix kernel-doc tags at the drivers/edac_*.h
  edac: fix kenel-doc markups at edac.h
  edac.rst: move concepts dictionary from edac.h

 Documentation/00-INDEX  |4 +-
 Documentation/admin-guide/index.rst |2 +-
 Documentation/admin-guide/ras.rst   | 1190 +++
 Documentation/driver-api/edac.rst   |  178 
 Documentation/driver-api/index.rst  |1 +
 Documentation/edac.txt  |  812 --
 MAINTAINERS |3 +-
 drivers/edac/altera_edac.c  |1 -
 drivers/edac/amd64_edac.h   |2 +-
 drivers/edac/amd76x_edac.c  |2 +-
 drivers/edac/amd8111_edac.c |1 -
 drivers/edac/amd8131_edac.c |1 -
 drivers/edac/cell_edac.c|2 +-
 drivers/edac/cpc925_edac.c  |1 -
 drivers/edac/e752x_edac.c   |2 +-
 drivers/edac/e7xxx_edac.c   |2 +-
 drivers/edac/edac_device.c  |   79 +-
 drivers/edac/{edac_core.h => edac_device.h} |  315 ++-
 drivers/edac/edac_device_sysfs.c|4 +-
 drivers/edac/edac_mc.c  |   93 +--
 drivers/edac/edac_mc.h  |  246 ++
 drivers/edac/edac_mc_sysfs.c|2 +-
 drivers/edac/edac_module.c  |2 +-
 drivers/edac/edac_module.h  |4 +-
 drivers/edac/edac_pci.c |   84 +-
 drivers/edac/edac_pci.h |  271 ++
 drivers/edac/edac_pci_sysfs.c   |   13 +-
 drivers/edac/fsl_ddr_edac.c |1 -
 drivers/edac/ghes_edac.c|2 +-
 drivers/edac/highbank_l2_edac.c |1 -
 drivers/edac/highbank_mc_edac.c |1 -
 drivers/edac/i3000_edac.c   |2 +-
 drivers/edac/i3200_edac.c   |2 +-
 drivers/edac/i5000_edac.c   |2 +-
 drivers/edac/i5100_edac.c   |1 -
 drivers/edac/i5400_edac.c   |2 +-
 drivers/edac/i7300_edac.c   |2 +-
 drivers/edac/i7core_edac.c  |2 +-
 drivers/edac/i82443bxgx_edac.c  |2 +-
 drivers/edac/i82860_edac.c  |2 +-
 drivers/edac/i82875p_edac.c |2 +-
 drivers/edac/i82975x_edac.c |2 +-
 drivers/edac/ie31200_edac.c |2 +-
 drivers/edac/layerscape_edac.c  |2 +-
 drivers/edac/mpc85xx_edac.c |1 -
 drivers/edac/mv64x60_edac.c |1 -
 drivers/edac/octeon_edac-l2c.c  |1 -