Re: [PATCH] tools: memory-model: add it to the Documentation body

Joel Fernandes
2019-07-27T14:14:53Z

On Fri, Jul 26, 2019 at 04:01:37PM -0300, Mauro Carvalho Chehab wrote:
> The books at tools/memory-model/Documentation are very well
> formatted. Congrats to the ones that wrote them!
>
> The manual conversion to ReST is really trivial:
>
> - Add document titles;
> - change the bullets on some lists;
> - mark code blocks.

Thanks so much, some feedback:
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

(1)
I could not find the table of contents appear in the HTML output for this.
Basically this list in the beginning doesn't render:
1. INTRODUCTION
2. BACKGROUND
3. A SIMPLE EXAMPLE
4. A SELECTION OF MEMORY MODELS
5. ORDERING AND CYCLES

Could we add a proper TOC with sections? My motivation for ReST here would be
to make the sections jumpable since it is a large document.

Also could we make the different sections appear as a tree in the left
sidebar?

(2) Arguably several function names in the document HTML output should appear
in monospace fonting and/or referring to the documentation for real function
names, but these can be fixed as we go, I guess.

(3) Things like smp_load_acquire() and spin_lock() should probably refer to
the documentation for those elsewhere..

(4) I would argue that every occurence of
A ->(some dependency) B should be replaced with fixed size font in the HTML
results.

Arguably it is better IMO if the whole document is fixed size font in the
HTML output because so many things need to be fixed size, but that my just be
my opinion.

thanks,

- Joel

> ---
> Documentation/core-api/refcount-vs-atomic.rst | 2 +-
> Documentation/index.rst | 1 +
> Documentation/tools/memory-model | 1 +
> .../memory-model/Documentation/cheatsheet.rst | 36 +++++
> .../memory-model/Documentation/cheatsheet.txt | 30 ----
> .../{explanation.txt => explanation.rst} | 151 ++++++++++--------
> tools/memory-model/Documentation/index.rst | 20 +++
> .../{recipes.txt => recipes.rst} | 41 ++---
> .../{references.txt => references.rst} | 46 +++---
> tools/memory-model/README | 10 +-
> 10 files changed, 192 insertions(+), 146 deletions(-)
> create mode 120000 Documentation/tools/memory-model
> create mode 100644 tools/memory-model/Documentation/cheatsheet.rst
> delete mode 100644 tools/memory-model/Documentation/cheatsheet.txt
> rename tools/memory-model/Documentation/{explanation.txt => explanation.rst} (97%)
> create mode 100644 tools/memory-model/Documentation/index.rst
> rename tools/memory-model/Documentation/{recipes.txt => recipes.rst} (96%)
> rename tools/memory-model/Documentation/{references.txt => references.rst} (71%)