Re: [PATCH] Documentation: fs: Convert xfs-delayed-logging-design.txt to ReSt
From: Jonathan Corbet
Date: Tue Aug 06 2019 - 13:46:44 EST
On Tue, 6 Aug 2019 10:03:23 +0100
Sheriff Esseson <sheriffesseson@xxxxxxxxx> wrote:
> Convert xfs-delayed-logging-design.txt to ReST and fix broken references.
> The enumerations at "Lifecycle Changes" breaks because of lines begining with
> "<", treat as diagrams.
[...]
> @@ -27,14 +30,18 @@ written to disk after change D, we would see in the log the following series
> of transactions, their contents and the log sequence number (LSN) of the
> transaction:
>
> + ============ ========= ==============
> Transaction Contents LSN
> + ============ ========= ==============
> A A X
> B A+B X+n
> C A+B+C X+n+m
> D A+B+C+D X+n+m+o
> <object written to disk>
> - E E Y (> X+n+m+o)
> + ------------------------------------------------------
> + E E Y (> X+n+m+o)
> F E+F Y+p
> + ============ ========= ==============
So this is really more of a diagram than a table; I'd suggest just using a
literal block like you did elsewhere.
[...]
> Lifecycle Changes
> +=================
>
> -The existing log item life cycle is as follows:
> +The existing log item life cycle is as follows::
>
> 1. Transaction allocate
> 2. Transaction reserve
This, instead, is a proper outline. I guess the literal block is OK, but
it feels like we could do better.
Thanks,
jon