Thread: doc patch: Spell I/O consistently

Hi Hackers,

I just noticed that a couple of places in the docs spell I/O as IO or
even io when not referring to literal table/view/column names or values
therein.  Here's a patch to fix them.

- ilmari


From ed5f9ce738dd6356d5d68e4cfed95d8d98d2cde5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dagfinn=20Ilmari=20Manns=C3=A5ker?= <ilmari@ilmari.org>
Date: Mon, 5 Feb 2024 15:52:08 +0000
Subject: [PATCH] doc: Spell I/O consistently

The pg_stat_io and pg_stat_copy_progress view docs spelled I/O as IO
or even io in some places when not referring to literal names or
string values.
---
 doc/src/sgml/monitoring.sgml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index d9b8b37585..5cf9363ac8 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -2584,7 +2584,7 @@
           <literal>vacuum</literal>: I/O operations performed outside of shared
           buffers while vacuuming and analyzing permanent relations. Temporary
           table vacuums use the same local buffer pool as other temporary table
-          IO operations and are tracked in <varname>context</varname>
+          I/O operations and are tracked in <varname>context</varname>
           <literal>normal</literal>.
          </para>
         </listitem>
@@ -2860,7 +2860,7 @@
     Columns tracking I/O time will only be non-zero when
     <xref linkend="guc-track-io-timing"/> is enabled. The user should be
     careful when referencing these columns in combination with their
-    corresponding IO operations in case <varname>track_io_timing</varname>
+    corresponding I/O operations in case <varname>track_io_timing</varname>
     was not enabled for the entire time since the last stats reset.
    </para>
   </note>
@@ -5734,7 +5734,7 @@
        <structfield>type</structfield> <type>text</type>
       </para>
       <para>
-       The io type that the data is read from or written to:
+       The I/O type that the data is read from or written to:
        <literal>FILE</literal>, <literal>PROGRAM</literal>,
        <literal>PIPE</literal> (for <command>COPY FROM STDIN</command> and
        <command>COPY TO STDOUT</command>), or <literal>CALLBACK</literal>
-- 
2.39.2

On Mon, Feb 05, 2024 at 03:59:27PM +0000, Dagfinn Ilmari Mannsåker wrote:
> I just noticed that a couple of places in the docs spell I/O as IO or
> even io when not referring to literal table/view/column names or values
> therein.  Here's a patch to fix them.

Makes sense to me to be consistent in these sections of the docs, so
applied.  Thanks!
--
Michael

Michael Paquier <michael@paquier.xyz> writes:

> On Mon, Feb 05, 2024 at 03:59:27PM +0000, Dagfinn Ilmari Mannsåker wrote:
>> I just noticed that a couple of places in the docs spell I/O as IO or
>> even io when not referring to literal table/view/column names or values
>> therein.  Here's a patch to fix them.
>
> Makes sense to me to be consistent in these sections of the docs, so
> applied.  Thanks!

Thanks!

- ilmari