Re: [PATCH] doc: Fix some typo errors in ras.rst

From: Matthew Wilcox <willy@infradead.org>
To: Waiman Long <longman@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>, Tony Luck <tony.luck@intel.com>,
	Borislav Petkov <bp@alien8.de>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	James Morse <james.morse@arm.com>,
	Robert Richter <rrichter@marvell.com>,
	linux-edac@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] doc: Fix some typo errors in ras.rst
Date: Tue, 5 May 2020 08:48:16 -0700	[thread overview]
Message-ID: <20200505154816.GH16070@bombadil.infradead.org> (raw)
In-Reply-To: <20200505151049.11134-1-longman@redhat.com>

On Tue, May 05, 2020 at 11:10:49AM -0400, Waiman Long wrote:
> Fix typo errors.

By reformatting it, you've successfully obscured what typos you've fixed.
As a result I read the whole paragraph, and ...

>  ECC memory
>  ----------
>  
> -As mentioned on the previous section, ECC memory has extra bits to be
> -used for error correction. So, on 64 bit systems, a memory module
> -has 64 bits of *data width*, and 74 bits of *total width*. So, there are
> -8 bits extra bits to be used for the error detection and correction
> +As mentioned on the previous section, ECC memory has extra bits to

s/on/in/

> +be used for error correction. So, on 64 bit systems, a memory module
> +has 64 bits of *data width*, and 72 bits of *total width*.

Usually a 64-bit system refers to the width of a pointer.  Here, it's
referring to the width of the memory system, which is rather confusing.
How about "In the above example" instead of "So, on 64 bit systems".

> So, there
> +are 8 extra bits to be used for the error detection and correction
>  mechanisms. Those extra bits are called *syndrome*\ [#f1]_\ [#f2]_.

This would read better as:

The extra 8 bits which are used for error detection and correction
are referred to as the *syndrome*\ [#f1]_\ [#f2]_.