Typo in "43.9.1. Reporting Errors and Messages"?

2022-08-01 Thread PG Doc comments form
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/14/plpgsql-errors-and-messages.html
Description:

Towards the end of the "43.9.1. Reporting Errors and Messages" section (here
https://www.postgresql.org/docs/current/plpgsql-errors-and-messages.html#PLPGSQL-STATEMENTS-RAISE)
we have the following sentence:

> If no condition name nor SQLSTATE is specified in a RAISE EXCEPTION
command, the default is to use ERRCODE_RAISE_EXCEPTION (P0001).

Looking at the list of error codes (here
https://www.postgresql.org/docs/current/errcodes-appendix.html) I think the
"ERRCODE_RAISE_EXCEPTION (P0001)" is a typo and should remove "ERRCODE_" and
simply read "RAISE_EXCEPTION (P0001)" or perhaps "ERRCODE =
'RAISE_EXCEPTION'" since that's how the default behaviour would be written
in a RAISE statement.

Many thanks,
Eric Mutta.


PostgreSQL 15 minor fixes in protocol.sgml

2022-08-01 Thread Ekaterina Kiryanova

Hello!

I've come across some typos in protocol.sgml for PostgreSQL 15 so please 
have a look at the attached patch.


I didn't include it in the patch but I also suggest removing single 
quotes around 'method' for the COMPRESSION option to help avoid 
confusion. (All the supported compression methods consist of a single 
word so in my opinion there is no need to use quotes in this case.)
-- COMPRESSION 
'method'


I've also noticed that there are two ways to describe an option: "If set 
to true" / "If true". As far as I know, the option here is specified by 
its name rather than being explicitly set to true so "if true" seems to 
be more correct, and this could be a slight improvement for this page. 
Please correct me if I'm wrong.


Another point worth mentioning is that only this file contains the 
phrase "two-phase transaction". I believe that "two-phase commit 
transaction" or "transaction prepared for two-phase commit" depending on 
the situation would be better wording.


And finally, could you please clarify this part?
-- The end LSN of the prepare transaction.
Is it a typo of "prepared transaction"? Or is it the LSN of the 
transaction for Prepare?

If it's the latter, perhaps it'd make more sense to capitalize it.

--
Best regards,
Ekaterina Kiryanova
Technical Writer
Postgres Professional
the Russian PostgreSQL Companydiff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 393311d304..f832aebfa6 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -2727,42 +2727,42 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
 
 
  COMPRESSION 'method'
  
   
Instructs the server to compress the backup using the specified
method. Currently, the supported methods are gzip,
lz4, and zstd.
   
  
 
 
 
  COMPRESSION_DETAIL detail
  
   
Specifies details for the chosen compression method. This should only
be used in conjunction with the COMPRESSION
option.  If the value is an integer, it specifies the compression
level.  Otherwise, it should be a comma-separated list of items,
-   each of the form keyword or
-   keyword=value. Currently, the supported keywords
+   each of the form keyword or
+   keyword=value. Currently, the supported keywords
are level and workers.
   
 
   
The level keyword sets the compression level.
For gzip the compression level should be an
integer between 1 and 9, for lz4 an integer
between 1 and 12, and for zstd an integer
between 1 and 22.
   
 
   
The workers keyword sets the number of threads
that should be used for parallel compression. Parallel compression
is supported only for zstd.
   
  
 
 
 
@@ -2887,111 +2887,111 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
   
  
 

   
 
   
After the second regular result set, a CopyOutResponse will be sent.
The payload of each CopyData message will contain a message in one of
the following formats:
   
 
   

 new archive (B)
 
  
   
Byte1('n')

-Identifes the messaage as indicating the start of a new archive.
+Identifies the message as indicating the start of a new archive.
 There will be one archive for the main data directory and one
 for each additional tablespace; each will use tar format
 (following the ustar interchange format specified
 in the POSIX 1003.1-2008 standard).

   
 
   
String

 The file name for this archive.

   
 
   
String

 For the main data directory, an empty string. For other
 tablespaces, the full path to the directory from which this
 archive was created.

   
  
 

 

 manifest (B)
 
  
   
Byte1('m')

-Identifes the message as indicating the start of the backup
+Identifies the message as indicating the start of the backup
 manifest.

   
  
 

 

 archive or manifest data (B)
 
  
   
Byte1('d')

-Identifes the message as containing archive or manifest data.
+Identifies the message as containing archive or manifest data.

   
 
   
Byten

 Data bytes.