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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This patch series convert the Documentation/edac.txt book to ReST and
add an EDAC documentation to the driver-api book.

The first 3 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 3 patches move existing documentation to edac_core.h
and convert them be properly parsed by kernel-doc script.

The next 4 patches convert Documentation/edac.txt to ReST, update
some outdated info there and move it to the admin-guide.

Patch 11 creates an edac.rst file at Documentation/driver-api, with
the kAPI defined by the EDAC core, and used by the EDAC drivers.

As this series make massive changes at edac_core.h, I added a
final patch on this series to make checkpatch.pl happy, addressing
a few issues there.

After reviewed, my plan is to submit this series via my EDAC tree, if
ok for everyone.

Regards,
Mauro

Mauro Carvalho Chehab (12):
  edac: edac_core.h: get rid of unused kobj_complete
  edac: edac_core.h: remove prototype for edac_pci_reset_delay_period()
  edac: edac_mc.c: Use an error code instead of -1
  edac: move documentation from edac_mc.c to edac_core.h
  edac: move documentation from edac_device to edac_core.h
  edac: move documentation from edac_pci*.c to edac_core.h
  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
  docs-rst: admin-guide: add documentation for EDAC
  driver-api: create an edac.rst file with EDAC documentation
  edac: edac_core.h: make checkpatch happy

 Documentation/{edac.txt => admin-guide/edac.rst} | 595 ++++++++++---------
 Documentation/admin-guide/index.rst              |   1 +
 Documentation/driver-api/edac.rst                |  70 +++
 Documentation/driver-api/index.rst               |   1 +
 drivers/edac/edac_core.h                         | 696 +++++++++++++++++------
 drivers/edac/edac_device.c                       |  58 --
 drivers/edac/edac_mc.c                           |  93 +--
 drivers/edac/edac_pci.c                          |  65 ---
 drivers/edac/edac_pci_sysfs.c                    |  11 -
 9 files changed, 913 insertions(+), 677 deletions(-)
 rename Documentation/{edac.txt => admin-guide/edac.rst} (53%)
 create mode 100644 Documentation/driver-api/edac.rst

-- 
2.7.4


--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux