[PATCH 0/1] tcg: convert tcg/README to rst

Mark Cave-Ayland posted 1 patch 2 weeks, 1 day ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20221123095445.31970-1-mark.cave-ayland@ilande.co.uk
There is a newer version of this series
docs/devel/atomics.rst   |    2 +
docs/devel/index-tcg.rst |    1 +
docs/devel/tcg-ops.rst   | 1018 ++++++++++++++++++++++++++++++++++++++
tcg/README               |  784 -----------------------------
4 files changed, 1021 insertions(+), 784 deletions(-)
create mode 100644 docs/devel/tcg-ops.rst
delete mode 100644 tcg/README
[PATCH 0/1] tcg: convert tcg/README to rst
Posted by Mark Cave-Ayland 2 weeks, 1 day ago
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>


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   | 1018 ++++++++++++++++++++++++++++++++++++++
 tcg/README               |  784 -----------------------------
 4 files changed, 1021 insertions(+), 784 deletions(-)
 create mode 100644 docs/devel/tcg-ops.rst
 delete mode 100644 tcg/README

-- 
2.30.2
Re: [PATCH 0/1] tcg: convert tcg/README to rst
Posted by BALATON Zoltan 2 weeks, 1 day ago
Hello,

On Wed, 23 Nov 2022, Mark Cave-Ayland wrote:
> 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.

Nice. Maybe including a link to the result could help review. Is this the 
right link?

https://github.com/mcayland/qemu/blob/tcg-readme-rst/docs/devel/tcg.rst

The second paragraph refers to tcg/README which is this file and this 
patch moves it so that sentence does not make much sense. Maybe it should 
be dropped and the only remaining sentence from that paragraph added to 
the previous. In fact the last sentence could also be added to avoid one 
sentence paragraphs and make the intro section just one paragraph.

Regards,
BALATON Zoltan

> 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>
>
>
> 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   | 1018 ++++++++++++++++++++++++++++++++++++++
> tcg/README               |  784 -----------------------------
> 4 files changed, 1021 insertions(+), 784 deletions(-)
> create mode 100644 docs/devel/tcg-ops.rst
> delete mode 100644 tcg/README
>
>
Re: [PATCH 0/1] tcg: convert tcg/README to rst
Posted by Mark Cave-Ayland 2 weeks, 1 day ago
On 23/11/2022 11:06, BALATON Zoltan wrote:

> Hello,
> 
> On Wed, 23 Nov 2022, Mark Cave-Ayland wrote:
>> 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.
> 
> Nice. Maybe including a link to the result could help review. Is this the right link?
> 
> https://github.com/mcayland/qemu/blob/tcg-readme-rst/docs/devel/tcg.rst

Ah no, that's a different file - the one introduced by this patch can be found at 
https://github.com/mcayland/qemu/blob/tcg-readme-rst/docs/devel/tcg-ops.rst.

> The second paragraph refers to tcg/README which is this file and this patch moves it 
> so that sentence does not make much sense. Maybe it should be dropped and the only 
> remaining sentence from that paragraph added to the previous. In fact the last 
> sentence could also be added to avoid one sentence paragraphs and make the intro 
> section just one paragraph.

I can certainly fix up the link to tcg/README in the file referenced above, as that's 
just the reverse of adding the link to the atomics documentation. I'll wait a bit for 
any further comments before posting a v2.

I'd be inclined to leave other changes for now so that the conversion patch can be 
merged sooner, and indeed it may be that this changes inspires someone to better 
tidy-up and/or reorganise both these documents as there is certainly some overlap 
between the two.


ATB,

Mark.