mbox series

[v3,0/3] doc: global data pointer

Message ID 20201005063010.8439-1-xypron.glpk@gmx.de
Headers show
Series doc: global data pointer | expand

Message

Heinrich Schuchardt Oct. 5, 2020, 6:30 a.m. UTC
Add the description of the global data pointer to the generated HTML
documentation.

The first patch converts the GD_FLG_* constants to an enum.
The second adds move Sphinx comments.
The third finally provides the HTML documentation.

v3:
	do not duplicate comments
v2:
	_flags must not be exposed to assembler code.
	This avoids a build failure on x86.

Heinrich Schuchardt (3):
  global_data.h: convert GD_FLG_* to enum
  global_data.h: add Sphinx documentation
  doc: global data pointer

 doc/develop/global_data.rst       |  53 ++++
 doc/develop/index.rst             |   1 +
 include/asm-generic/global_data.h | 478 +++++++++++++++++++++++++-----
 3 files changed, 455 insertions(+), 77 deletions(-)
 create mode 100644 doc/develop/global_data.rst

--
2.28.0