[coreboot-gerrit] Change in coreboot[master]: Documentation: Add chain-include list of headers

[HAOUAS Elyes (Code Review)]

HAOUAS Elyes has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/50286 )

Change subject: Documentation: Add chain-include list of headers
......................................................................

Documentation: Add chain-include list of headers

This list a non exhaustive intentionally indirect includes.

Change-Id: I474d0d4bd660b62c24508bc3eba67154e820d8a4
Signed-off-by: Elyes HAOUAS 
---
A Documentation/chain-include.md
1 file changed, 39 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/86/50286/1

diff --git a/Documentation/chain-include.md b/Documentation/chain-include.md
new file mode 100644
index 0000000..82b8fee
--- /dev/null
+++ b/Documentation/chain-include.md
@@ -0,0 +1,39 @@
+# Chain includes
+
+This is a non exhaustive list of headers that intentionally chain-include other headers:
+
+* include/cbfs.h:
+	* commonlib/cbfs.h:
+		* commonlib/bsd/cbfs_private.h:
+			* commonlib/bsd/cb_err.h
+			* commonlib/bsd/cbfs_serialized.h
+
+* include/console/console.h
+	* commonlib/loglevel.h
+	* console/vtxprintf.h
+
+* include/device/mmio.h:
+	* arch/mmio.h
+
+* include/device/pci_ops.h:
+	* arch/pci_ops.h:
+		* device/pci_mmio_cfg.h
+		* arch/pci_io_cfg.h:
+			* arch/io.h
+
+* include/gpio.h:
+	* soc/gpio.h
+
+* include/types.h:
+	* commonlib/bsd/cb_err.h
+	* stdbool.h
+	* stdint.h
+	* stddef.h
+
+
+**NOTE**:
+* src/include/*.h files: To avoid redundant inclusions, it would be better to direct include
+the header when this one is in src/include root directory.
+* src/include/types.h: <types.h> is not mandatory if you use only one or two src/include/*.h
+chain-provided by <types.h>.
+