Re: [PATCH v2 1/1] tcg: convert tcg/README to rst

[Fabiano Rosas <farosas@suse.de>]

Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk> writes:

> Convert tcg/README to rst and move it to docs/devel as a new "TCG Intermediate
> Representation" page. There are a few minor changes to improve the aesthetic
> of the final output which are as follows:
>
>   - Rename the title from "Tiny Code Generator - Fabrice Bellard" to "TCG
>     Intermediate Representation"
>
>   - Remove the section numbering
>
>   - Add the missing parameters to the ssadd_vec operations in the "Host
>     vector operations" section
>
>   - Change the path to the Atomic Operations document to use a proper
>     reference
>
>   - Replace tcg/README in tcg.rst with a proper reference to the new document
>
> Signed-off-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>

Reviewed-by: Fabiano Rosas <farosas@suse.de>

I have a couple of suggestions for a small restructuring. But we could
do that after this patch gets in, no worries.

The index now looks like:

Translator Internals           <--- mentions what TCG stands for
    CPU state optimisations    <--- references TBs and targets
    Direct block chaining
    Self-modifying code and...
    Exception support
    MMU emulation

TCG Intermediate Representation  <--- duplicate section name (see below)
    Introduction                 <--- 2nd time we mention what TCG stands for
    Definitions                  <--- defines TBs and targets
    Intermediate representation  <--- duplicate section name
    Instruction Reference
    Backend
    Recommended coding rules for best performance

I think it would be nicer to merge the text from "Introduction" with the
paragraph that mentions TCG in "Translator Internals" instead of
linking;

and moving the whole "Definitions" section to before "CPU state
optimizations". That way we keep the definitions before the text that
mentions the terms and remove the duplicate "intermediate
representation" in the index.