Commit6095069

committed

Improve wording in pg_dump compression docs

A couple minor corrections in pg_dump comments and docs, related to therecently introduced compression API.Reported-by: Justin PryzbyDiscussion:https://postgr.es/m/20230227044910.GO1653@telsasoft.com

1 parent34ce114 commit6095069Copy full SHA for 6095069

File tree

-6

lines changed

-6

lines changed

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ PostgreSQL documentation`
`331`	`331`	`can read. A directory format archive can be manipulated with`
`332`	`332`	`standard Unix tools; for example, files in an uncompressed archive`
`333`	`333`	`can be compressed with the <application>gzip</application> or`
`334`		`- <application>lz4</application>tool.`
	`334`	`+ <application>lz4</application> tools.`
`335`	`335`	`This format is compressed by default using <literal>gzip</literal>`
`336`	`336`	`and also supports parallel dumps.`
`337`	`337`	`</para>`
`@@ -654,8 +654,8 @@ PostgreSQL documentation`
`654`	`654`	`<listitem>`
`655`	`655`	`<para>`
`656`	`656`	`Specify the compression method and/or the compression level to use.`
`657`		`- The compression method can be set to <literal>gzip</literal> or`
`658`		`- <literal>lz4</literal> or <literal>none</literal> for no compression.`
	`657`	`+ The compression method can be set to <literal>gzip</literal>,`
	`658`	`+ <literal>lz4</literal>, or <literal>none</literal> for no compression.`
`659`	`659`	`A compression detail string can optionally be specified. If the`
`660`	`660`	`detail string is an integer, it specifies the compression level.`
`661`	`661`	`Otherwise, it should be a comma-separated list of items, each of the`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ struct CompressFileHandle`
`172`	`172`	`externCompressFileHandle*InitCompressFileHandle(constpg_compress_specificationcompression_spec);`
`173`	`173`
`174`	`174`	`/*`
`175`		`- * Initialize a compress file stream.Deffer the compression algorithm`
	`175`	`+ * Initialize a compress file stream.Infer the compression algorithm`
`176`	`176`	`* from 'path', either by examining its suffix or by appending the supported`
`177`	`177`	`* suffixes in 'path'.`
`178`	`178`	`*/`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -161,8 +161,8 @@ typedef struct LZ4File`
`161`	`161`	`}LZ4File;`
`162`	`162`
`163`	`163`	`/*`
`164`		`- * LZ4 equivalent to feof() or gzeof().The end of fileisreached if there`
`165`		`- *is nodecompressed output in the overflow buffer and the end of the file`
	`164`	`+ * LZ4 equivalent to feof() or gzeof(). Return true iff thereisno`
	`165`	`+ * decompressed output in the overflow buffer and the end of the backing file`
`166`	`166`	`* is reached.`
`167`	`167`	`*/`
`168`	`168`	`staticint`

Comments

(0)