All of lore.kernel.org
 help / color / mirror / Atom feed
From: Heinrich Schuchardt <xypron.glpk@gmx.de>
To: u-boot@lists.denx.de
Subject: [PATCH v3 0/3] doc: global data pointer
Date: Sun, 27 Sep 2020 14:36:06 +0200	[thread overview]
Message-ID: <20200927123609.37517-1-xypron.glpk@gmx.de> (raw)

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:
	x86 uses register fs for global data pointer
v2:
	enum gd_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 | 460 +++++++++++++++++++++++++-----
 3 files changed, 446 insertions(+), 68 deletions(-)
 create mode 100644 doc/develop/global_data.rst

--
2.28.0

             reply	other threads:[~2020-09-27 12:36 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-27 12:36 Heinrich Schuchardt [this message]
2020-09-27 12:36 ` [PATCH v3 1/3] global_data.h: convert GD_FLG_* to enum Heinrich Schuchardt
2020-09-27 12:36 ` [PATCH v3 2/3] global_data.h: add Sphinx documentation Heinrich Schuchardt
2020-09-27 12:36 ` [PATCH v3 3/3] doc: global data pointer Heinrich Schuchardt
2020-09-28  4:24   ` Simon Glass
2020-10-05  6:30 [PATCH v3 0/3] " Heinrich Schuchardt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200927123609.37517-1-xypron.glpk@gmx.de \
    --to=xypron.glpk@gmx.de \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.