NotificationsYou must be signed in to change notification settings
Fork5
Star26

Commit4266509

committed

Improve markup of cmdsynopsis elements

Add more markup in particular so that the command options appearconsistently in monospace in the HTML output.On the vacuumdb reference page, remove listing all the possibleoptions in the synopsis. They have become too many now; we have thedetailed options list for that.

1 parent61c84b4 commit4266509Copy full SHA for 4266509

File tree

8 files changed

+109

-89

lines changed

doc/src/sgml/ref

8 files changed

+109

-89

lines changed

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

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,16 +23,16 @@ PostgreSQL documentation`
`23`	`23`	`<cmdsynopsis>`
`24`	`24`	`<command>clusterdb</command>`
`25`	`25`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`26`		`- <group><arg>--verbose</arg><arg>-v</arg></group>`
`27`		`- <arg>--table \| -t <replaceable>table</replaceable> </arg>`
	`26`	`+ <group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>`
	`27`	`+ <arg><group choice="plain"><arg><option>--table</option></arg><arg><option>-t</option></arg></group> <replaceable>table</replaceable> </arg>`
`28`	`28`	`<arg><replaceable>dbname</replaceable></arg>`
`29`	`29`	`</cmdsynopsis>`
`30`	`30`
`31`	`31`	`<cmdsynopsis>`
`32`	`32`	`<command>clusterdb</command>`
`33`	`33`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`34`		`- <group><arg>--verbose</arg><arg>-v</arg></group>`
`35`		`- <group><arg>--all</arg><arg>-a</arg></group>`
	`34`	`+ <group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>`
	`35`	`+ <group><arg><option>--all</option></arg><arg><option>-a</option></arg></group>`
`36`	`36`	`</cmdsynopsis>`
`37`	`37`	`</refsynopsisdiv>`
`38`	`38`

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

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ PostgreSQL documentation`
`30`	`30`	`<cmdsynopsis>`
`31`	`31`	`<command>createlang</command>`
`32`	`32`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`33`		`- <group choice="plain"><arg>--list</arg><arg>-l</arg></group>`
	`33`	`+ <group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>`
`34`	`34`	`<arg choice="plain"><replaceable>dbname</replaceable></arg>`
`35`	`35`	`</cmdsynopsis>`
`36`	`36`	`</refsynopsisdiv>`

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

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ PostgreSQL documentation`
`30`	`30`	`<cmdsynopsis>`
`31`	`31`	`<command>droplang</command>`
`32`	`32`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`33`		`- <group choice="plain"><arg>--list</arg><arg>-l</arg></group>`
	`33`	`+ <group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>`
`34`	`34`	`<arg choice="plain"><replaceable>dbname</replaceable></arg>`
`35`	`35`	`</cmdsynopsis>`
`36`	`36`	`</refsynopsisdiv>`

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

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,11 @@ PostgreSQL documentation`
`24`	`24`	`<command>initdb</command>`
`25`	`25`	`<arg rep="repeat"><replaceable>option</replaceable></arg>`
`26`	`26`	`<group choice="plain">`
`27`		`- <arg>--pgdata</arg>`
`28`		`- <arg>-D </arg>`
`29`		`- <replaceable>directory</replaceable>`
	`27`	`+ <group choice="opt">`
	`28`	`+ <arg><option>--pgdata</option></arg>`
	`29`	`+ <arg><option>-D</option></arg>`
	`30`	`+ </group>`
	`31`	`+ <replaceable> directory</replaceable>`
`30`	`32`	`</group>`
`31`	`33`	`</cmdsynopsis>`
`32`	`34`	`</refsynopsisdiv>`

`‎doc/src/sgml/ref/pg_ctl-ref.sgml`

Lines changed: 56 additions & 56 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,109 +22,109 @@ PostgreSQL documentation`
`22`	`22`	`<refsynopsisdiv>`
`23`	`23`	`<cmdsynopsis>`
`24`	`24`	`<command>pg_ctl</command>`
`25`		`- <arg choice="plain">init[db]</arg>`
`26`		`- <arg>-s</arg>`
`27`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
`28`		`- <arg>-o <replaceable>initdb-options</replaceable></arg>`
	`25`	`+ <arg choice="plain"><option>init[db]</option></arg>`
	`26`	`+ <arg><option>-s</option></arg>`
	`27`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
	`28`	`+ <arg><option>-o</option> <replaceable>initdb-options</replaceable></arg>`
`29`	`29`	`</cmdsynopsis>`
`30`	`30`
`31`	`31`	`<cmdsynopsis>`
`32`	`32`	`<command>pg_ctl</command>`
`33`		`- <arg choice="plain">start</arg>`
`34`		`- <arg>-w</arg>`
`35`		`- <arg>-t <replaceable>seconds</replaceable></arg>`
`36`		`- <arg>-s</arg>`
`37`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
`38`		`- <arg>-l <replaceable>filename</replaceable></arg>`
`39`		`- <arg>-o <replaceable>options</replaceable></arg>`
`40`		`- <arg>-p <replaceable>path</replaceable></arg>`
`41`		`- <arg>-c</arg>`
	`33`	`+ <arg choice="plain"><option>start</option></arg>`
	`34`	`+ <arg><option>-w</option></arg>`
	`35`	`+ <arg><option>-t</option> <replaceable>seconds</replaceable></arg>`
	`36`	`+ <arg><option>-s</option></arg>`
	`37`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
	`38`	`+ <arg><option>-l</option> <replaceable>filename</replaceable></arg>`
	`39`	`+ <arg><option>-o</option> <replaceable>options</replaceable></arg>`
	`40`	`+ <arg><option>-p</option> <replaceable>path</replaceable></arg>`
	`41`	`+ <arg><option>-c</option></arg>`
`42`	`42`	`</cmdsynopsis>`
`43`	`43`
`44`	`44`	`<cmdsynopsis>`
`45`	`45`	`<command>pg_ctl</command>`
`46`		`- <arg choice="plain">stop</arg>`
`47`		`- <arg>-W</arg>`
`48`		`- <arg>-t <replaceable>seconds</replaceable></arg>`
`49`		`- <arg>-s</arg>`
`50`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
`51`		`- <arg>-m`
	`46`	`+ <arg choice="plain"><option>stop</option></arg>`
	`47`	`+ <arg><option>-W</option></arg>`
	`48`	`+ <arg><option>-t</option> <replaceable>seconds</replaceable></arg>`
	`49`	`+ <arg><option>-s</option></arg>`
	`50`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
	`51`	`+ <arg><option>-m</option>`
`52`	`52`	`<group choice="plain">`
`53`		`- <arg>s[mart]</arg>`
`54`		`- <arg>f[ast]</arg>`
`55`		`- <arg>i[mmediate]</arg>`
	`53`	`+ <arg><option>s[mart]</option></arg>`
	`54`	`+ <arg><option>f[ast]</option></arg>`
	`55`	`+ <arg><option>i[mmediate]</option></arg>`
`56`	`56`	`</group>`
`57`	`57`	`</arg>`
`58`	`58`	`</cmdsynopsis>`
`59`	`59`
`60`	`60`	`<cmdsynopsis>`
`61`	`61`	`<command>pg_ctl</command>`
`62`		`- <arg choice="plain">restart</arg>`
`63`		`- <arg>-w</arg>`
`64`		`- <arg>-t <replaceable>seconds</replaceable></arg>`
`65`		`- <arg>-s</arg>`
`66`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
`67`		`- <arg>-c</arg>`
`68`		`- <arg>-m`
	`62`	`+ <arg choice="plain"><option>restart</option></arg>`
	`63`	`+ <arg><option>-w</option></arg>`
	`64`	`+ <arg><option>-t</option> <replaceable>seconds</replaceable></arg>`
	`65`	`+ <arg><option>-s</option></arg>`
	`66`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
	`67`	`+ <arg><option>-c</option></arg>`
	`68`	`+ <arg><option>-m</option>`
`69`	`69`	`<group choice="plain">`
`70`		`- <arg>s[mart]</arg>`
`71`		`- <arg>f[ast]</arg>`
`72`		`- <arg>i[mmediate]</arg>`
	`70`	`+ <arg><option>s[mart]</option></arg>`
	`71`	`+ <arg><option>f[ast]</option></arg>`
	`72`	`+ <arg><option>i[mmediate]</option></arg>`
`73`	`73`	`</group>`
`74`	`74`	`</arg>`
`75`		`- <arg>-o <replaceable>options</replaceable></arg>`
	`75`	`+ <arg><option>-o</option> <replaceable>options</replaceable></arg>`
`76`	`76`	`</cmdsynopsis>`
`77`	`77`
`78`	`78`	`<cmdsynopsis>`
`79`	`79`	`<command>pg_ctl</command>`
`80`		`- <arg choice="plain">reload</arg>`
`81`		`- <arg>-s</arg>`
`82`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
	`80`	`+ <arg choice="plain"><option>reload</option></arg>`
	`81`	`+ <arg><option>-s</option></arg>`
	`82`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
`83`	`83`	`</cmdsynopsis>`
`84`	`84`
`85`	`85`	`<cmdsynopsis>`
`86`	`86`	`<command>pg_ctl</command>`
`87`		`- <arg choice="plain">status</arg>`
`88`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
	`87`	`+ <arg choice="plain"><option>status</option></arg>`
	`88`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
`89`	`89`	`</cmdsynopsis>`
`90`	`90`
`91`	`91`	`<cmdsynopsis>`
`92`	`92`	`<command>pg_ctl</command>`
`93`		`- <arg choice="plain">promote</arg>`
`94`		`- <arg>-s</arg>`
`95`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
	`93`	`+ <arg choice="plain"><option>promote</option></arg>`
	`94`	`+ <arg><option>-s</option></arg>`
	`95`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
`96`	`96`	`</cmdsynopsis>`
`97`	`97`
`98`	`98`	`<cmdsynopsis>`
`99`	`99`	`<command>pg_ctl</command>`
`100`		`- <arg choice="plain">kill</arg>`
	`100`	`+ <arg choice="plain"><option>kill</option></arg>`
`101`	`101`	`<arg choice="plain"><replaceable>signal_name</replaceable></arg>`
`102`	`102`	`<arg choice="plain"><replaceable>process_id</replaceable></arg>`
`103`	`103`	`</cmdsynopsis>`
`104`	`104`
`105`	`105`	`<cmdsynopsis>`
`106`	`106`	`<command>pg_ctl</command>`
`107`		`- <arg choice="plain">register</arg>`
`108`		`- <arg>-N <replaceable>servicename</replaceable></arg>`
`109`		`- <arg>-U <replaceable>username</replaceable></arg>`
`110`		`- <arg>-P <replaceable>password</replaceable></arg>`
`111`		`- <arg>-D <replaceable>datadir</replaceable></arg>`
`112`		`- <arg>-S`
	`107`	`+ <arg choice="plain"><option>register</option></arg>`
	`108`	`+ <arg><option>-N</option> <replaceable>servicename</replaceable></arg>`
	`109`	`+ <arg><option>-U</option> <replaceable>username</replaceable></arg>`
	`110`	`+ <arg><option>-P</option> <replaceable>password</replaceable></arg>`
	`111`	`+ <arg><option>-D</option> <replaceable>datadir</replaceable></arg>`
	`112`	`+ <arg><option>-S</option>`
`113`	`113`	`<group choice="plain">`
`114`		`- <arg>a[uto]</arg>`
`115`		`- <arg>d[emand]</arg>`
	`114`	`+ <arg><option>a[uto]</option></arg>`
	`115`	`+ <arg><option>d[emand]</option></arg>`
`116`	`116`	`</group>`
`117`	`117`	`</arg>`
`118`		`- <arg>-w</arg>`
`119`		`- <arg>-t <replaceable>seconds</replaceable></arg>`
`120`		`- <arg>-s</arg>`
`121`		`- <arg>-o <replaceable>options</replaceable></arg>`
	`118`	`+ <arg><option>-w</option></arg>`
	`119`	`+ <arg><option>-t</option> <replaceable>seconds</replaceable></arg>`
	`120`	`+ <arg><option>-s</option></arg>`
	`121`	`+ <arg><option>-o</option> <replaceable>options</replaceable></arg>`
`122`	`122`	`</cmdsynopsis>`
`123`	`123`
`124`	`124`	`<cmdsynopsis>`
`125`	`125`	`<command>pg_ctl</command>`
`126`		`- <arg choice="plain">unregister</arg>`
`127`		`- <arg>-N <replaceable>servicename</replaceable></arg>`
	`126`	`+ <arg choice="plain"><option>unregister</option></arg>`
	`127`	`+ <arg><option>-N</option> <replaceable>servicename</replaceable></arg>`
`128`	`128`	`</cmdsynopsis>`
`129`	`129`	`</refsynopsisdiv>`
`130`	`130`

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

Lines changed: 8 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,14 @@ PostgreSQL documentation`
`22`	`22`	`<refsynopsisdiv>`
`23`	`23`	`<cmdsynopsis>`
`24`	`24`	`<command>pg_resetxlog</command>`
`25`		`- <arg>-f</arg>`
`26`		`- <arg>-n</arg>`
`27`		`- <arg>-o<replaceable class="parameter">oid</replaceable></arg>`
`28`		`- <arg>-x <replaceable class="parameter">xid</replaceable></arg>`
`29`		`- <arg>-e <replaceable class="parameter">xid_epoch</replaceable></arg>`
`30`		`- <arg>-m <replaceable class="parameter">mxid</replaceable></arg>`
`31`		`- <arg>-O <replaceable class="parameter">mxoff</replaceable></arg>`
`32`		`- <arg>-l <replaceable class="parameter">timelineid</replaceable>,<replaceable class="parameter">fileid</replaceable>,<replaceable class="parameter">seg</replaceable></arg>`
	`25`	`+ <arg><option>-f</option></arg>`
	`26`	`+ <arg><option>-n</option></arg>`
	`27`	`+ <arg><option>-o</option> <replaceable class="parameter">oid</replaceable></arg>`
	`28`	`+ <arg><option>-x</option> <replaceable class="parameter">xid</replaceable></arg>`
	`29`	`+ <arg><option>-e</option> <replaceable class="parameter">xid_epoch</replaceable></arg>`
	`30`	`+ <arg><option>-m</option> <replaceable class="parameter">mxid</replaceable></arg>`
	`31`	`+ <arg><option>-O</option> <replaceable class="parameter">mxoff</replaceable></arg>`
	`32`	`+ <arg><option>-l</option> <replaceable class="parameter">timelineid</replaceable>,<replaceable class="parameter">fileid</replaceable>,<replaceable class="parameter">seg</replaceable></arg>`
`33`	`33`	`<arg choice="plain"><replaceable>datadir</replaceable></arg>`
`34`	`34`	`</cmdsynopsis>`
`35`	`35`	`</refsynopsisdiv>`

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

Lines changed: 22 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,21 +23,39 @@ PostgreSQL documentation`
`23`	`23`	`<cmdsynopsis>`
`24`	`24`	`<command>reindexdb</command>`
`25`	`25`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`26`		`- <arg>--table \| -t <replaceable>table</replaceable> </arg>`
`27`		`- <arg>--index \| -i <replaceable>index</replaceable> </arg>`
	`26`	`+ <group choice="opt">`
	`27`	`+ <group choice="plain">`
	`28`	`+ <arg><option>--table</option></arg>`
	`29`	`+ <arg><option>-t</option></arg>`
	`30`	`+ </group>`
	`31`	`+ <replaceable>table</replaceable>`
	`32`	`+ </group>`
	`33`	`+ <group choice="opt">`
	`34`	`+ <group choice="plain">`
	`35`	`+ <arg><option>--index</option></arg>`
	`36`	`+ <arg><option>-i</option></arg>`
	`37`	`+ </group>`
	`38`	`+ <replaceable>index</replaceable>`
	`39`	`+ </group>`
`28`	`40`	`<arg><replaceable>dbname</replaceable></arg>`
`29`	`41`	`</cmdsynopsis>`
`30`	`42`
`31`	`43`	`<cmdsynopsis>`
`32`	`44`	`<command>reindexdb</command>`
`33`	`45`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`34`		`- <arg>--all \| -a</arg>`
	`46`	`+ <group choice="plain">`
	`47`	`+ <arg><option>--all</option></arg>`
	`48`	`+ <arg><option>-a</option></arg>`
	`49`	`+ </group>`
`35`	`50`	`</cmdsynopsis>`
`36`	`51`
`37`	`52`	`<cmdsynopsis>`
`38`	`53`	`<command>reindexdb</command>`
`39`	`54`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`40`		`- <arg>--system \| -s</arg>`
	`55`	`+ <group choice="plain">`
	`56`	`+ <arg><option>--system</option></arg>`
	`57`	`+ <arg><option>-s</option></arg>`
	`58`	`+ </group>`
`41`	`59`	`<arg><replaceable>dbname</replaceable></arg>`
`42`	`60`	`</cmdsynopsis>`
`43`	`61`	`</refsynopsisdiv>`

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

Lines changed: 12 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,12 +23,13 @@ PostgreSQL documentation`
`23`	`23`	`<cmdsynopsis>`
`24`	`24`	`<command>vacuumdb</command>`
`25`	`25`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`26`		`- <group><arg>--full</arg><arg>-f</arg></group>`
`27`		`- <group><arg>--freeze</arg><arg>-F</arg></group>`
`28`		`- <group><arg>--verbose</arg><arg>-v</arg></group>`
`29`		`- <group><arg>--analyze</arg><arg>-z</arg></group>`
`30`		`- <group><arg>--analyze-only</arg><arg>-Z</arg></group>`
`31`		`- <arg>--table \| -t <replaceable>table</replaceable>`
	`26`	`+ <arg rep="repeat"><replaceable>option</replaceable></arg>`
	`27`	`+ <arg>`
	`28`	`+ <group choice="plain">`
	`29`	`+ <arg><option>--table</option></arg>`
	`30`	`+ <arg><option>-t</option></arg>`
	`31`	`+ </group>`
	`32`	`+ <replaceable>table</replaceable>`
`32`	`33`	`<arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>`
`33`	`34`	`</arg>`
`34`	`35`	`<arg><replaceable>dbname</replaceable></arg>`
`@@ -37,12 +38,11 @@ PostgreSQL documentation`
`37`	`38`	`<cmdsynopsis>`
`38`	`39`	`<command>vacuumdb</command>`
`39`	`40`	`<arg rep="repeat"><replaceable>connection-option</replaceable></arg>`
`40`		`- <group><arg>--full</arg><arg>-f</arg></group>`
`41`		`- <group><arg>--freeze</arg><arg>-F</arg></group>`
`42`		`- <group><arg>--verbose</arg><arg>-v</arg></group>`
`43`		`- <group><arg>--analyze</arg><arg>-z</arg></group>`
`44`		`- <group><arg>--analyze-only</arg><arg>-Z</arg></group>`
`45`		`- <group><arg>--all</arg><arg>-a</arg></group>`
	`41`	`+ <arg rep="repeat"><replaceable>option</replaceable></arg>`
	`42`	`+ <group choice="plain">`
	`43`	`+ <arg><option>--all</option></arg>`
	`44`	`+ <arg><option>-a</option></arg>`
	`45`	`+ </group>`
`46`	`46`	`</cmdsynopsis>`
`47`	`47`	`</refsynopsisdiv>`
`48`	`48`

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!

Commit4266509

File tree

8 files changed

8 files changed

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

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

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

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

`‎doc/src/sgml/ref/pg_ctl-ref.sgml`

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

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

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

0 commit comments