mbox series

[v2,0/1] tcg: convert tcg/README to rst

Message ID 20221130100434.64207-1-mark.cave-ayland@ilande.co.uk (mailing list archive)
Headers show
Series tcg: convert tcg/README to rst | expand

Message

Mark Cave-Ayland Nov. 30, 2022, 10:04 a.m. UTC
This is something I've had lying around in the background for a while, and I
finally managed to get it in a state suitable for submission. The main
motivation was that I wanted to have a TCG operation reference that was
easily viewable online in a web browser.

The patch converts tcg/README to rst and then moves it from tcg/README to a
new "TCG Intermediate Representation" section in docs/devel.

The conversion is fairly straightforward, with a few minor touch-ups to
produce a more aesthetic result which are documented in the commit message.

Signed-off-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>

v2:
- Use | to designate lines in the "Instruction Reference" tables to fix
  wrapping issues noticed by Peter
- Add reference to new document in docs/devel/tcg.rst instead of tcg/README
  as suggested by Zoltan


Mark Cave-Ayland (1):
  tcg: convert tcg/README to rst

 docs/devel/atomics.rst   |   2 +
 docs/devel/index-tcg.rst |   1 +
 docs/devel/tcg-ops.rst   | 942 +++++++++++++++++++++++++++++++++++++++
 docs/devel/tcg.rst       |   2 +-
 tcg/README               | 784 --------------------------------
 5 files changed, 946 insertions(+), 785 deletions(-)
 create mode 100644 docs/devel/tcg-ops.rst
 delete mode 100644 tcg/README