Changing "Hot Standby" to "hot standby"

Started by Daniel Westermann (DWE)about 4 years ago17 messageshackers
Jump to latest
#1Daniel Westermann (DWE)
daniel.westermann@dbi-services.com

Hi,

with reference to the discussion in docs: /messages/by-id/2221339.1645896597@sss.pgh.pa.us

Here is a patch that changes "Hot Standby" to "hot standby" in high-availability.sgml, so we have a consistent wording.
Thoughts?

There are other places where hot standby is capitalized, but I guess we should start here.

Regards
Daniel

Attachments:

align_hot_standby.patchtext/x-patch; name=align_hot_standby.patchDownload+14-14
#2Aleksander Alekseev
aleksander@timescale.com
In reply to: Daniel Westermann (DWE) (#1)
Re: Changing "Hot Standby" to "hot standby"

Hi Daniel,

Here is a patch that changes "Hot Standby" to "hot standby" in

high-availability.sgml, so we have a consistent wording.

Thoughts?

```
-   <title>Hot Standby Parameter Reference</title>
+   <title>hot standby Parameter Reference</title>
```

Pretty sure that for titles we should keep English capitalization rules.

--
Best regards,
Aleksander Alekseev

#3Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Aleksander Alekseev (#2)
Re: Changing "Hot Standby" to "hot standby"

Hi Aleksander,

Pretty sure that for titles we should keep English capitalization rules.

Done like that. Thanks for taking a look.

Regards
Daniel

Attachments:

align_hot_standby_v2.patchtext/x-patch; name=align_hot_standby_v2.patchDownload+12-12
#4Kyotaro Horiguchi
horikyota.ntt@gmail.com
In reply to: Daniel Westermann (DWE) (#3)
Re: Changing "Hot Standby" to "hot standby"

At Wed, 2 Mar 2022 15:22:44 +0000, "Daniel Westermann (DWE)" <daniel.westermann@dbi-services.com> wrote in

Pretty sure that for titles we should keep English capitalization rules.

Done like that. Thanks for taking a look.

    <para>
-    Hot Standby feedback propagates upstream, whatever the cascaded arrangement.
+    hot standby feedback propagates upstream, whatever the cascaded arrangement
    <para>
-    Hot Standby is the term used to describe the ability to connect to
+    hot standby is the term used to describe the ability to connect to

They look like decapitalizing the first word in a sentsnce.

regards.

--
Kyotaro Horiguchi
NTT Open Source Software Center

#5Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Kyotaro Horiguchi (#4)
Re: Changing "Hot Standby" to "hot standby"

Hi Kyotaro,

    <para>
-    Hot Standby is the term used to describe the ability to connect to
+    hot standby is the term used to describe the ability to connect to

They look like decapitalizing the first word in a sentsnce.

Thanks for having a look. Are you suggesting to change it like this?
-    Hot Standby is the term used to describe the ability to connect to
+    Hot standby is the term used to describe the ability to connect to

Regards
Daniel

#6Kyotaro Horiguchi
horikyota.ntt@gmail.com
In reply to: Daniel Westermann (DWE) (#5)
Re: Changing "Hot Standby" to "hot standby"

At Thu, 3 Mar 2022 06:55:43 +0000, "Daniel Westermann (DWE)" <daniel.westermann@dbi-services.com> wrote in

Hi Kyotaro,

    <para>
-    Hot Standby is the term used to describe the ability to connect to
+    hot standby is the term used to describe the ability to connect to

They look like decapitalizing the first word in a sentsnce.

Thanks for having a look. Are you suggesting to change it like this?
-    Hot Standby is the term used to describe the ability to connect to
+    Hot standby is the term used to describe the ability to connect to

Yes. Isn't it the right form of a sentence?

regards.

--
Kyotaro Horiguchi
NTT Open Source Software Center

#7Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Kyotaro Horiguchi (#6)
Re: Changing "Hot Standby" to "hot standby"
Thanks for having a look. Are you suggesting to change it like this?
-    Hot Standby is the term used to describe the ability to connect to
+    Hot standby is the term used to describe the ability to connect to

Yes.  Isn't it the right form of a sentence?

Done like that.

Regards
Daniel

Attachments:

align_hot_standby_v3.patchtext/x-patch; name=align_hot_standby_v3.patchDownload+12-12
#8Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Daniel Westermann (DWE) (#7)
Re: Changing "Hot Standby" to "hot standby"
Thanks for having a look. Are you suggesting to change it like this?
-    Hot Standby is the term used to describe the ability to connect to
+    Hot standby is the term used to describe the ability to connect to

Yes. Isn't it the right form of a sentence?

I've created and entry in the Commitfest 2022-07 for this.

Regards
Daniel

#9Robert Treat
xzilla@users.sourceforge.net
In reply to: Daniel Westermann (DWE) (#8)
Re: Changing "Hot Standby" to "hot standby"

On Mon, Mar 7, 2022 at 11:06 AM Daniel Westermann (DWE)
<daniel.westermann@dbi-services.com> wrote:

Thanks for having a look. Are you suggesting to change it like this?
-    Hot Standby is the term used to describe the ability to connect to
+    Hot standby is the term used to describe the ability to connect to

Yes. Isn't it the right form of a sentence?

I've created and entry in the Commitfest 2022-07 for this.

I think one more small change...

    A standby server can also be used for read-only queries, in which case
-   it is called a Hot Standby server. See <xref linkend="hot-standby"/> for
+   it is called a hot standby server. See <xref linkend="hot-standby"/> for
    more information.
    A standby server can also be used for read-only queries, in which case
-   it is called a Hot Standby server. See <xref linkend="hot-standby"/> for
+   it is called a <firstterm>hot standby</firstterm> server. See
<xref linkend="hot-standby"/> for
    more information.

Robert Treat
https://xzilla.net

#10Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Robert Treat (#9)
Re: Changing "Hot Standby" to "hot standby"

I think one more small change...

    A standby server can also be used for read-only queries, in which case
-   it is called a Hot Standby server. See <xref linkend="hot-standby"/> for
+   it is called a hot standby server. See <xref linkend="hot-standby"/> for
    more information.
    A standby server can also be used for read-only queries, in which case
-   it is called a Hot Standby server. See <xref linkend="hot-standby"/> for
+   it is called a <firstterm>hot standby</firstterm> server. See
<xref linkend="hot-standby"/> for
    more information.

Thanks for having a look. Done that way.

Regards
Daniel

Attachments:

align_hot_standby_v4.patchtext/x-patch; name=align_hot_standby_v4.patchDownload+13-13
#11Michael Paquier
michael@paquier.xyz
In reply to: Daniel Westermann (DWE) (#10)
Re: Changing "Hot Standby" to "hot standby"

On Wed, Mar 09, 2022 at 07:45:32AM +0000, Daniel Westermann (DWE) wrote:

Thanks for having a look. Done that way.

Hmm. Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1). Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:
$ git grep "hot standby" | wc -l
259
$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.
--
Michael

#12Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Michael Paquier (#11)
Re: Changing "Hot Standby" to "hot standby"

Hi Michael,

On Wed, Mar 09, 2022 at 07:45:32AM +0000, Daniel Westermann (DWE) wrote:

Thanks for having a look. Done that way.

Hmm.  Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1).  Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other places.

Regards
Daniel

#13Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Daniel Westermann (DWE) (#12)
Re: Changing "Hot Standby" to "hot standby"

Hmm.  Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1).  Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an >earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other >places.

Attached a new version which also modifies amcheck.sgml, config.sgml, protocol.sgml, and mvcc.sgml accordingly.

Regards
Daniel

Attachments:

align_hot_standby_v5.patchtext/x-patch; name=align_hot_standby_v5.patchDownload+21-21
#14Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Daniel Westermann (DWE) (#13)
Re: Changing "Hot Standby" to "hot standby"

Hmm.  Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1).  Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an >>earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other >>places.

Attached a new version which also modifies amcheck.sgml, config.sgml, protocol.sgml, and mvcc.sgml accordingly.

Regards
Daniel

From: Daniel Westermann (DWE) <daniel.westermann@dbi-services.com>
Sent: Wednesday, March 9, 2022 15:15
To: Michael Paquier <michael@paquier.xyz>
Cc: Robert Treat <rob@xzilla.net>; Kyotaro Horiguchi <horikyota.ntt@gmail.com>; aleksander@timescale.com <aleksander@timescale.com>; pgsql-hackers@lists.postgresql.org <pgsql-hackers@lists.postgresql.org>
Subject: Re: Changing "Hot Standby" to "hot standby"
 

Hmm.  Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1).  Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an >>earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other >>places.

Attached a new version which also modifies amcheck.sgml, config.sgml, protocol.sgml, and mvcc.sgml accordingly.

Sending this again as my last two mails did not seem to reach the archives or the commitfest. Or do they need moderation somehow?

Regards
Daniel

Attachments:

align_hot_standby_v5.patchtext/x-patch; name=align_hot_standby_v5.patchDownload+21-21
#15Robert Treat
xzilla@users.sourceforge.net
In reply to: Daniel Westermann (DWE) (#14)
Re: Changing "Hot Standby" to "hot standby"

On Thu, Mar 10, 2022 at 8:45 AM Daniel Westermann (DWE)
<daniel.westermann@dbi-services.com> wrote:

Hmm. Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1). Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an >>earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other >>places.

Attached a new version which also modifies amcheck.sgml, config.sgml, protocol.sgml, and mvcc.sgml accordingly.

Regards
Daniel

From: Daniel Westermann (DWE) <daniel.westermann@dbi-services.com>
Sent: Wednesday, March 9, 2022 15:15
To: Michael Paquier <michael@paquier.xyz>
Cc: Robert Treat <rob@xzilla.net>; Kyotaro Horiguchi <horikyota.ntt@gmail.com>; aleksander@timescale.com <aleksander@timescale.com>; pgsql-hackers@lists.postgresql.org <pgsql-hackers@lists.postgresql.org>
Subject: Re: Changing "Hot Standby" to "hot standby"

Hmm. Outside the title that had better use upper-case characters for
the first letter of each word, I can see references to the pattern you
are trying to eliminate in amcheck.sgml (1), config.sgml (3),
protocol.sgml (3) and mvcc.sgml (1). Shouldn't you refresh these as
well if the point is to make the full set of docs consistent?

As of the full tree, I can see that:

$ git grep "hot standby" | wc -l
259

$ git grep "Hot Standby" | wc -l
73

So there is a trend for one of the two.

Thanks for looking at it. Yes, I am aware there are other places which would need to be changed and I think I mentioned that in an >>earlier Email. Are you suggesting to change all at once? I wanted to start with the documentation and then continue with the other >>places.

Attached a new version which also modifies amcheck.sgml, config.sgml, protocol.sgml, and mvcc.sgml accordingly.

Sending this again as my last two mails did not seem to reach the archives or the commitfest. Or do they need moderation somehow?

Not sure why the previous emails didn't go through, and still doesn't
look like they were picked up. In the interest of progress though,
attaching an updated patch with some minor wordsmithing; lmk if you'd
prefer this differently

Robert Treat
https://xzilla.net

Attachments:

align_hot_standby_v6-rt.patchapplication/octet-stream; name=align_hot_standby_v6-rt.patchDownload+21-21
#16Michael Paquier
michael@paquier.xyz
In reply to: Robert Treat (#15)
Re: Changing "Hot Standby" to "hot standby"

On Thu, Mar 10, 2022 at 05:58:05PM -0500, Robert Treat wrote:

Not sure why the previous emails didn't go through, and still doesn't
look like they were picked up. In the interest of progress though,
attaching an updated patch with some minor wordsmithing; lmk if you'd
prefer this differently

Looks the same as v5 for me, that applies the same consistency rules
everywhere in the docs. So applied this one.
--
Michael

#17Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Michael Paquier (#16)
Re: Changing "Hot Standby" to "hot standby"

Looks the same as v5 for me, that applies the same consistency rules
everywhere in the docs.  So applied this one.

Thank you, Michael