[PATCHES] minor documentation improvements
This patch makes a few minor improvements to the docs: make the conventions more consistent, and improve the ANALYZE ref page. -Neil Index: doc/src/sgml/perform.sgml === RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/perform.sgml,v retrieving revision 1.31 diff -c -r1.31 perform.sgml *** doc/src/sgml/perform.sgml 31 Aug 2003 17:32:19 - 1.31 --- doc/src/sgml/perform.sgml 5 Sep 2003 00:15:21 - *** *** 603,609 PostgreSQL planner will switch from exhaustive search to a genetic probabilistic search through a limited number of possibilities. (The switch-over threshold is !set by the geqo_threshold run-time parameter.) The genetic search takes less time, but it won't necessarily find the best possible plan. --- 603,609 PostgreSQL planner will switch from exhaustive search to a genetic probabilistic search through a limited number of possibilities. (The switch-over threshold is !set by the GEQO_THRESHOLD run-time parameter.) The genetic search takes less time, but it won't necessarily find the best possible plan. Index: doc/src/sgml/plpgsql.sgml === RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/plpgsql.sgml,v retrieving revision 1.22 diff -c -r1.22 plpgsql.sgml *** doc/src/sgml/plpgsql.sgml 3 Sep 2003 22:17:07 - 1.22 --- doc/src/sgml/plpgsql.sgml 5 Sep 2003 00:11:49 - *** *** 1350,1356 allow users to allow users to define set-returning functions that do not have this limitation. Currently, the point at which data begins being written to disk is controlled by the !sort_mem configuration variable. Administrators who have sufficient memory to store larger result sets in memory should consider increasing this parameter. --- 1350,1356 allow users to allow users to define set-returning functions that do not have this limitation. Currently, the point at which data begins being written to disk is controlled by the !SORT_MEM configuration variable. Administrators who have sufficient memory to store larger result sets in memory should consider increasing this parameter. Index: doc/src/sgml/ref/analyze.sgml === RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/analyze.sgml,v retrieving revision 1.13 diff -c -r1.13 analyze.sgml *** doc/src/sgml/ref/analyze.sgml 31 Aug 2003 17:32:21 - 1.13 --- doc/src/sgml/ref/analyze.sgml 5 Sep 2003 00:02:12 - *** *** 28,37 Description !ANALYZE collects statistics about the contents of !tables in the database, and stores the results in !the system table pg_statistic. Subsequently, !the query planner uses the statistics to help determine the most efficient execution plans for queries. --- 28,37 Description !ANALYZE collects statistics about the contents !of tables in the database, and stores the results in the system !table pg_statistic. Subsequently, the query !planner uses these statistics to help determine the most efficient execution plans for queries. *** *** 105,153 !Unlike VACUUM FULL, !ANALYZE requires !only a read lock on the target table, so it can run in parallel with !other activity on the table. !For large tables, ANALYZE takes a random sample of the !table contents, rather than examining every row. This allows even very !large tables to be analyzed in a small amount of time. Note, however, !that the statistics are only approximate, and will change slightly each !time ANALYZE is run, even if the actual table contents !did not change. This may result in small changes in the planner's !estimated costs shown by EXPLAIN. !The collected statistics usually include a list of some of the most common !values in each column and a histogram showing the approximate data !distribution in each column. One or both of these may be omitted if !ANALYZE deems them uninteresting (for example, in !a unique-key column, there are no common values) or if the column !data type does not support the appropriate operators. There is more !information about the statistics in . The extent of analysis can be controlled by adjusting the !default_statistics_target parameter variable, or on a !column-by-column basis by setting the per-column !statistics target with ALTER TABLE ... ALTER COLUMN ... SET !STATISTICS (see !). The !target value sets the maximum number of entries in the most-common-value !list and the maximum number of bins in the histogram. The default !targ
Re: [PATCHES] minor documentation improvements
Neil Conway writes: > This patch makes a few minor improvements to the docs: make the > conventions more consistent, They are consistent: They're all lowercase. Until now. -- Peter Eisentraut [EMAIL PROTECTED] ---(end of broadcast)--- TIP 4: Don't 'kill -9' the postmaster
Re: [PATCHES] minor documentation improvements
Bruce Momjian writes: > Huh? We have been uppercasing GUC variable names in most places > already. Currently, the documentation contains about 2 GUC variable names in upper case, the rest is lower case. (The exception are the list headings in the main description in runtime.sgml, which are all upper case. That is a bit inconsistent, but I think it's OK, because here they sort of serve as section titles.) Also note that postgresql.conf, command-line option equivalents, and SET commands all tend to use them in lower case, so that seems like the direction to go. -- Peter Eisentraut [EMAIL PROTECTED] ---(end of broadcast)--- TIP 2: you can get off all lists at once with the unregister command (send "unregister YourEmailAddressHere" to [EMAIL PROTECTED])
Re: [PATCHES] minor documentation improvements
Peter Eisentraut wrote: > Neil Conway writes: > > > This patch makes a few minor improvements to the docs: make the > > conventions more consistent, > > They are consistent: They're all lowercase. Until now. Huh? We have been uppercasing GUC variable names in most places already. -- Bruce Momjian| http://candle.pha.pa.us [EMAIL PROTECTED] | (610) 359-1001 + If your life is a hard drive, | 13 Roberts Road + Christ can be your backup.| Newtown Square, Pennsylvania 19073 ---(end of broadcast)--- TIP 7: don't forget to increase your free space map settings
Re: [PATCHES] minor documentation improvements
Peter Eisentraut wrote: > Bruce Momjian writes: > > > Huh? We have been uppercasing GUC variable names in most places > > already. > > Currently, the documentation contains about 2 GUC variable names in upper > case, the rest is lower case. (The exception are the list headings in the > main description in runtime.sgml, which are all upper case. That is a bit > inconsistent, but I think it's OK, because here they sort of serve as > section titles.) Also note that postgresql.conf, command-line option > equivalents, and SET commands all tend to use them in lower case, so that > seems like the direction to go. Oh, OK, got it. -- Bruce Momjian| http://candle.pha.pa.us [EMAIL PROTECTED] | (610) 359-1001 + If your life is a hard drive, | 13 Roberts Road + Christ can be your backup.| Newtown Square, Pennsylvania 19073 ---(end of broadcast)--- TIP 3: if posting/reading through Usenet, please send an appropriate subscribe-nomail command to [EMAIL PROTECTED] so that your message can get through to the mailing list cleanly
Re: [PATCHES] minor documentation improvements
On Fri, 2003-09-05 at 17:16, Peter Eisentraut wrote: > Currently, the documentation contains about 2 GUC variable names in upper > case, the rest is lower case. There are significantly more than 2 uses of upper-case GUC names in the docs (more like 10 by my guess), but in any case, the current usage is inconsistent. So, is upper-case or lower-case better? I'd personally prefer lower-case, I suppose, but I'm not too bothered either way. -Neil ---(end of broadcast)--- TIP 3: if posting/reading through Usenet, please send an appropriate subscribe-nomail command to [EMAIL PROTECTED] so that your message can get through to the mailing list cleanly
Re: [PATCHES] minor documentation improvements
Peter Eisentraut <[EMAIL PROTECTED]> writes: > Neil Conway writes: >> This patch makes a few minor improvements to the docs: make the >> conventions more consistent, > They are consistent: They're all lowercase. Until now. The varnames listed in runtime.sgml are uppercase though, no? Or were you intending the variable definitions to be upper case and all the references lower case? It's not real clear what the intended style is, and I have to say that I thought Neil was heading in the intended direction also. regards, tom lane ---(end of broadcast)--- TIP 5: Have you checked our extensive FAQ? http://www.postgresql.org/docs/faqs/FAQ.html
Re: [PATCHES] minor documentation improvements
Peter Eisentraut <[EMAIL PROTECTED]> writes: > Bruce Momjian writes: >> Huh? We have been uppercasing GUC variable names in most places >> already. > Currently, the documentation contains about 2 GUC variable names in upper > case, the rest is lower case. (The exception are the list headings in the > main description in runtime.sgml, which are all upper case. That is a bit > inconsistent, but I think it's OK, because here they sort of serve as > section titles.) Okay, that seems reasonable. Ignore my prior message --- I hadn't come across this one yet. regards, tom lane ---(end of broadcast)--- TIP 5: Have you checked our extensive FAQ? http://www.postgresql.org/docs/faqs/FAQ.html
Re: [PATCHES] minor documentation improvements
Neil Conway writes: > So, is upper-case or lower-case better? I'd personally prefer > lower-case, I suppose, but I'm not too bothered either way. If you want to change them all to lowercase, that would be fine by me. At least it would prevent more people being confused into inconsistencies in the future. -- Peter Eisentraut [EMAIL PROTECTED] ---(end of broadcast)--- TIP 4: Don't 'kill -9' the postmaster
Re: [PATCHES] minor documentation improvements
Patch applied. I will now go through and lowercase all the GUC variable names, as agreed upon. --- Neil Conway wrote: > This patch makes a few minor improvements to the docs: make the > conventions more consistent, and improve the ANALYZE ref page. > > -Neil > [ Attachment, skipping... ] > > ---(end of broadcast)--- > TIP 3: if posting/reading through Usenet, please send an appropriate > subscribe-nomail command to [EMAIL PROTECTED] so that your > message can get through to the mailing list cleanly -- Bruce Momjian| http://candle.pha.pa.us [EMAIL PROTECTED] | (610) 359-1001 + If your life is a hard drive, | 13 Roberts Road + Christ can be your backup.| Newtown Square, Pennsylvania 19073 ---(end of broadcast)--- TIP 8: explain analyze is your friend
