Skip to contentSkip to conversation

Documentation: fs: Convert xfs-delayed-logging-design.txt to ReSt

PATCH In review Sheriff Esseson 2 participants 2 messages Aug 6, 2019 Documentation

lore
Share & tools
lore

Sheriff Esseson

author
#0 lore raw

PATCH 1/1 Documentation: fs: Convert xfs-delayed-logging-design.txt to ReSt

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.

Signed-off-by Sheriff Esseson <sheriffesseson at gmail.com>
---
 Documentation/filesystems/index.rst           |  1 +
 ...ign.txt => xfs-delayed-logging-design.rst} | 69 +++++++++++--------
 MAINTAINERS                                   |  2 +-
 3 files changed, 44 insertions(+), 28 deletions(-)
 rename Documentation/filesystems/{xfs-delayed-logging-design.txt => xfs-delayed-logging-design.rst} (96%)
Documentation/filesystems/index.rst +1 -0
index 2de2fe2ab078..0b94ff710b67 100644
@@ -32,3 +32,4 @@ filesystem implementations.
 
    journalling
    fscrypt
+   xfs-delayed-logging-design
Documentation/filesystems/xfs-delayed-logging-design.rst renamed from Documentation/filesystems/xfs-delayed-logging-design.txt +42 -27

182 lines not on this page · raw message

MAINTAINERS +1 -1
index 6c49b48cfd69..acbce11c3d49 100644
@@ -17664,7 +17664,7 @@ T:	git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
 S:	Supported
 F:	Documentation/admin-guide/xfs.rst
 F:	Documentation/ABI/testing/sysfs-fs-xfs
-F:	Documentation/filesystems/xfs-delayed-logging-design.txt
+F:	Documentation/filesystems/xfs-delayed-logging-design.rst
 F:	Documentation/filesystems/xfs-self-describing-metadata.txt
 F:	fs/xfs/
 F:	include/uapi/linux/dqblk_xfs.h
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 3 lines · On Tue, 6 Aug 2019 10:03:23 +0100 Sheriff Esseson <sheriffesseson at…

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.

[...]

Quoted 7 lines
Documentation/filesystems/xfs-delayed-logging-design.rst renamed from Documentation/filesystems/xfs-delayed-logging-design.txt +2 -0
@@ -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
+        ============           =========        ==============

Documentation/filesystems/xfs-delayed-logging-design.rst written to disk after change D, we would see in the log the following series · line 44

Quoted 10 lines
Documentation/filesystems/xfs-delayed-logging-design.rst renamed from Documentation/filesystems/xfs-delayed-logging-design.txt +3 -1
 	   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.

[...]

Documentation/filesystems/xfs-delayed-logging-design.rst woken by the wrong event. · line 705

Quoted 8 lines
Documentation/filesystems/xfs-delayed-logging-design.rst renamed from Documentation/filesystems/xfs-delayed-logging-design.txt +2 -1
 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