NotificationsYou must be signed in to change notification settings
Fork6
Star31

Commit856ca51

committed

Doc: clarify use of NULL to drop comments and security labels.

This was only mentioned in the description of the text/label, whichare marked as being in quotes in the synopsis, which can causeconfusion (as witnessed on IRC).Also separate the literal and NULL cases in the parameter list, persuggestion from Tom Lane.Also add an example of dropping a security label.Dagfinn Ilmari Mannsåker, with some tweaks by meDiscussion:https://postgr.es/m/87sffqk4zp.fsf@wibble.ilmari.org

1 parenteae0e20 commit856ca51Copy full SHA for 856ca51

File tree

2 files changed

+34

-11

lines changed

doc/src/sgml/ref
- comment.sgml
- security_label.sgml

2 files changed

+34

-11

lines changed

`‎doc/src/sgml/ref/comment.sgml`

Lines changed: 12 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ COMMENT ON`
`66`	`66`	`TRIGGER <replaceable class="parameter">trigger_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> \|`
`67`	`67`	`TYPE <replaceable class="parameter">object_name</replaceable> \|`
`68`	`68`	`VIEW <replaceable class="parameter">object_name</replaceable>`
`69`		`-} IS'<replaceable class="parameter">text</replaceable>'`
	`69`	`+} IS{<replaceable class="parameter">string_literal</replaceable> \| NULL }`
`70`	`70`
`71`	`71`	`<phrase>where <replaceable>aggregate_signature</replaceable> is:</phrase>`
`72`	`72`
`@@ -263,11 +263,19 @@ COMMENT ON`
`263`	`263`	`</varlistentry>`
`264`	`264`
`265`	`265`	`<varlistentry>`
`266`		`- <term><replaceable class="parameter">text</replaceable></term>`
	`266`	`+ <term><replaceable class="parameter">string_literal</replaceable></term>`
`267`	`267`	`<listitem>`
`268`	`268`	`<para>`
`269`		`- The new comment, written as a string literal; or <literal>NULL</literal>`
`270`		`- to drop the comment.`
	`269`	`+ The new comment contents, written as a string literal.`
	`270`	`+ </para>`
	`271`	`+ </listitem>`
	`272`	`+ </varlistentry>`
	`273`	`+`
	`274`	`+ <varlistentry>`
	`275`	`+ <term><literal>NULL</literal></term>`
	`276`	`+ <listitem>`
	`277`	`+ <para>`
	`278`	`+ Write <literal>NULL</literal> to drop the comment.`
`271`	`279`	`</para>`
`272`	`280`	`</listitem>`
`273`	`281`	`</varlistentry>`

`‎doc/src/sgml/ref/security_label.sgml`

Lines changed: 22 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ SECURITY LABEL [ FOR <replaceable class="parameter">provider</replaceable> ] ON`
`44`	`44`	`TABLESPACE <replaceable class="parameter">object_name</replaceable> \|`
`45`	`45`	`TYPE <replaceable class="parameter">object_name</replaceable> \|`
`46`	`46`	`VIEW <replaceable class="parameter">object_name</replaceable>`
`47`		`-} IS'<replaceable class="parameter">label</replaceable>'`
	`47`	`+} IS{<replaceable class="parameter">string_literal</replaceable> \| NULL }`
`48`	`48`
`49`	`49`	`<phrase>where <replaceable>aggregate_signature</replaceable> is:</phrase>`
`50`	`50`
`@@ -178,11 +178,19 @@ SECURITY LABEL [ FOR <replaceable class="parameter">provider</replaceable> ] ON`
`178`	`178`	`</varlistentry>`
`179`	`179`
`180`	`180`	`<varlistentry>`
`181`		`- <term><replaceable class="parameter">label</replaceable></term>`
	`181`	`+ <term><replaceable class="parameter">string_literal</replaceable></term>`
`182`	`182`	`<listitem>`
`183`	`183`	`<para>`
`184`		`- The new security label, written as a string literal; or <literal>NULL</literal>`
`185`		`- to drop the security label.`
	`184`	`+ The new setting of the security label, written as a string literal.`
	`185`	`+ </para>`
	`186`	`+ </listitem>`
	`187`	`+ </varlistentry>`
	`188`	`+`
	`189`	`+ <varlistentry>`
	`190`	`+ <term><literal>NULL</literal></term>`
	`191`	`+ <listitem>`
	`192`	`+ <para>`
	`193`	`+ Write <literal>NULL</literal> to drop the security label.`
`186`	`194`	`</para>`
`187`	`195`	`</listitem>`
`188`	`196`	`</varlistentry>`
`@@ -193,12 +201,19 @@ SECURITY LABEL [ FOR <replaceable class="parameter">provider</replaceable> ] ON`
`193`	`201`	`<title>Examples</title>`
`194`	`202`
`195`	`203`	`<para>`
`196`		`- The following example shows how the security label of a tablemight`
`197`		`- be changed.`
	`204`	`+ The following example shows how the security label of a tablecould`
	`205`	`+ beset orchanged:`
`198`	`206`
`199`	`207`	`<programlisting>`
`200`	`208`	`SECURITY LABEL FOR selinux ON TABLE mytable IS 'system_u:object_r:sepgsql_table_t:s0';`
`201`		`-</programlisting></para>`
	`209`	`+</programlisting>`
	`210`	`+`
	`211`	`+ To remove the label:`
	`212`	`+`
	`213`	`+<programlisting>`
	`214`	`+SECURITY LABEL FOR selinux ON TABLE mytable IS NULL;`
	`215`	`+</programlisting>`
	`216`	`+ </para>`
`202`	`217`	`</refsect1>`
`203`	`218`
`204`	`219`	`<refsect1>`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit856ca51

File tree

2 files changed

2 files changed

`‎doc/src/sgml/ref/comment.sgml`

`‎doc/src/sgml/ref/security_label.sgml`

0 commit comments