summaryrefslogtreecommitdiff
path: root/doc/src
AgeCommit message (Collapse)Author
2020-05-14docs: PG 13 relnotes: add links and SGML formattingBruce Momjian
2020-05-14Doc: hack on table 26.1 till it fits in PDF format.Tom Lane
I abbreviated the heck out of the column headings, and made a few small wording changes, to get it to build warning-free. I can't say that the result is pretty, but it's probably better than removing this table entirely. As of this commit, we have zero "exceed the available area" warnings in a US-letter PDF build, and one such warning (about an 863-millipoint overrun) in an A4 build. I expect to get rid of that one by renaming wait events, so I'm not doing anything about it at the formatting level. Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-14Doc: tweak examples to silence line-too-long PDF build warnings.Tom Lane
In one or two places it seemed reasonable to modify the example so as to shorten its output slightly; but for the most part I just added a &zwsp; after 67 characters, which is the most we can fit on a line of monospace text in A4 format. Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-14Initial pgindent and pgperltidy run for v13.Tom Lane
Includes some manual cleanup of places that pgindent messed up, most of which weren't per project style anyway. Notably, it seems some people didn't absorb the style rules of commit c9d297751, because there were a bunch of new occurrences of function calls with a newline just after the left paren, all with faulty expectations about how the rest of the call would get indented.
2020-05-14doc: PG 13 relnotes: move docbook version change to doc sect.Bruce Momjian
2020-05-14Doc: Fix some inconsistencies with markupsMichael Paquier
This addresses some whitespace issues with programlisting, and corrects the spelling of "Enter PEM pass phrase" to be consistent with the code. Author: Daniel Gustafsson Discussion: https://postgr.es/m/401F9024-20EA-4239-83C4-6B7AD35F94BD@yesql.se
2020-05-13Doc: split up wait_event table.Tom Lane
The previous design for this table didn't really work in narrow views, such as PDF output; besides which its reliance on large morerows values made it a pain to maintain (cf ab3e4fbd5, for example). I experimented with a couple of ways to fix it, but the best and simplest is to split it up into a separate table for each event type category. I also rearranged the event ordering to be strictly alphabetical, as nobody would ever be able to find entries otherwise. There is work afoot to revise the set of event names described in this table, but this commit just changes the layout, not the contents. In passing, add a missing entry to pg_locks.locktype, and cross-reference that to the related wait event list. Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-13Doc: reformat catalog/view description tables.Tom Lane
This changes our catalog and view descriptions to use a style inspired by the new format for function/operator tables: each table entry is formatted roughly like a <varlistentry>, with the column name and type on the first line and then an indented description. This provides much more room for expansive descriptions than we had before, and thereby eliminates a passel of PDF build warnings. Discussion: https://postgr.es/m/12984.1588643549@sss.pgh.pa.us
2020-05-13doc: PG 13 relnotes: adjust wal_skip_threshold wordingBruce Momjian
2020-05-12docs: PG 13 relnotes: adjust wal_skip_threshold and UTF8 itemsBruce Momjian
2020-05-11doc: PG 13 relnotes: add documentation section and reformatBruce Momjian
Add section about function table reformatting.
2020-05-11Doc: hack table 13.2 "Conflicting Lock Modes" till it fits in PDF.Tom Lane
I can't see any way to make this table fit in PDF column width without either a fundamental redesign or abbreviating EXCLUSIVE. So I did the latter. It'd be nicer if the abbreviating didn't leak into the HTML output as well; but the hackery required to make the output different seems like more trouble than it's really worth. Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-11doc: PG 13 relnotes: add duplicate btree optimization detailsBruce Momjian
2020-05-11doc: PG 13 relnotes: cumulative fixes from email feedbackBruce Momjian
2020-05-11Doc: fix remaining over-length entries in SQL keywords table.Tom Lane
Even after the tweaking I did in commit 5545b69ae, some of the longer keywords mentioned in the SQL standard don't fit the available space in PDF output. I experimented with various solutions like putting such keywords on their own table lines, but everything looked ugly or confusing or both; worse, the weirdness also appeared in the HTML version, which (normally) doesn't need it. The best answer seems to be to insert &zwsp; into long keywords so that they can be broken into two lines when, and only when, needed. It doesn't look too awful if the break happens after an underscore --- and fortunately, all the problematic keywords have underscores. Discussion: https://postgr.es/m/6916.1589146280@sss.pgh.pa.us
2020-05-11Doc: fix "Unresolved ID reference" warnings, clean up man page cross-refs.Tom Lane
Use xreflabel attributes instead of endterm attributes to control the appearance of links to subsections of SQL command reference pages. This is simpler, it matches what we do elsewhere (e.g. for GUC variables), and it doesn't draw "Unresolved ID reference" warnings from the PDF toolchain. Fix some places where the text was absolutely dependent on an <xref> rendering exactly so, by using a <link> around the required text instead. At least one of those spots had already been turned into bad grammar by subsequent changes, and the whole idea is just too fragile for my taste. <xref> does NOT have fixed output, don't write as if it does. Consistently include a page-level link in cross-man-page references, because otherwise they are useless/nonsensical in man-page output. Likewise, be consistent about mentioning "below" or "above" in same-page references; we were doing that in about 90% of the cases, but now it's 100%. Also get rid of another nonfunctional-in-PDF idea, of making cross-references to functions by sticking ID tags on <row> constructs. We can put the IDs on <indexterm>s instead --- which is probably not any more sensible in abstract terms, but it works where the other doesn't. (There is talk of attaching cross-reference IDs to most or all of the docs' function descriptions, but for now I just fixed the two that exist.) Discussion: https://postgr.es/m/14480.1589154358@sss.pgh.pa.us
2020-05-10Doc: marginal hacking to remove some PDF build warnings.Tom Lane
This patch eliminates a few more "exceed the available area" warnings whose causes aren't particularly connected to anything else. The only one really worthy of comment is that I increased the space allowed for an <orderedlist>'s numbers, because the default of 1em doesn't quite work for more than one digit. The rest are one-off insertions of &zwsp; and suchlike tweaks, in places where they shouldn't do any damage to the material. (In particular, although I split some long identifiers with zwsp's, there are other nearby occurrences of each one; so those changes shouldn't hurt greppability of the document sources.)
2020-05-09Doc: fix assorted misstatements of fact in catalog & system view docs.Tom Lane
I made up a very crude hack to compare the docs with reality (as embodied in the system catalogs) ... and indeed they don't match everywhere. Missing oid columns, wrong data types, wrong "references" links, columns listed in the wrong order. None of this seems quite important enough to back-patch.
2020-05-08Fix several DDL issues of generated columns versus inheritancePeter Eisentraut
Several combinations of generated columns and inheritance in CREATE TABLE were not handled correctly. Specifically: - Disallow a child column specifying a generation expression if the parent column is a generated column. The child column definition must be unadorned and the parent column's generation expression will be copied. - Prohibit a child column of a generated parent column specifying default values or identity. - Allow a child column of a not-generated parent column specifying itself as a generated column. This previously did not work, but it was possible to arrive at the state via other means (involving ALTER TABLE), so it seems sensible to support it. Add tests for each case. Also add documentation about the rules involving generated columns and inheritance. Discussion: https://www.postgresql.org/message-id/flat/15830.1575468847%40sss.pgh.pa.us https://www.postgresql.org/message-id/flat/2678bad1-048f-519a-ef24-b12962f41807%40enterprisedb.com https://www.postgresql.org/message-id/flat/CAJvUf_u4h0DxkCMCeEKAWCuzGUTnDP-G5iVmSwxLQSXn0_FWNQ%40mail.gmail.com
2020-05-08Fix inconsistency in pg_buffercache docs.Amit Kapila
Commit 6e654546fb avoids locking bufmgr partitions to make pg_buffercache less disruptive on production systems but forgot to update the docs. Reported-by: Sawada Masahiko Author: Sawada Masahiko Reviewed-by: Amit Kapila Backpatch-through: 10 Discussion: https://postgr.es/m/CA+fd4k6sD8oeP1qJbFAor=rCpYckU9DsywHiYx3x5Hz5Z8Ua_w@mail.gmail.com
2020-05-07Doc: update remaining tables of functions/operators for new layout.Tom Lane
This converts the contrib documentation to the new style, and mops up a couple of function tables that were outside chapter 9 in the main docs. A few contrib modules choose not to present their functions in the standard tabular format. There might be room to rethink those decisions now that the standard format is more friendly to verbose descriptions. But I have not undertaken to do that here; I just converted existing tables.
2020-05-07doc: PG 13 relnotes: adjust partitioning itemsBruce Momjian
Reported-by: Amit Langote
2020-05-07doc: PG 13 relnotes: adjust wording and Unicode itemBruce Momjian
2020-05-07doc: PG 13 relnotes: adjust partition items and attributionsBruce Momjian
This merges three partition publication items into two.
2020-05-06doc: PG 13 relnotes, update TOAST item to mention decompressionBruce Momjian
Reported-by: Andrey M. Borodin Discussion: https://postgr.es/m/D49B37B1-E2B9-4F67-8C6C-5CFD4015E8C5@yandex-team.ru
2020-05-06pgbench: document that the default data loading is client-sideBruce Momjian
Reported-by: Fabien COELHO Discussion: https://postgr.es/m/alpine.DEB.2.22.394.2005051811320.2183756@pseudo
2020-05-06Doc: remove now-redundant align specifications in colspecs.Tom Lane
In the wake of commit f21599311, we don't need to set table columns' align specs retail. Undo a few such settings I'd added in commit 5545b69ae. (The column width adjustments stay, though.)
2020-05-06Doc: further fooling-about with rendering of tables in PDF output.Tom Lane
I concluded that we really just ought to force all tables in PDF output to default to "left" alignment (instead of "justify"); that is what the HTML toolchain does and that's what most people have been designing the tables to look good with. There are few if any places where "justify" produces better-looking output, and there are many where it looks horrible. So change stylesheet-fo.xsl to make that true. Also tweak column widths in a few more tables to make them look better and avoid "exceed the available area" warnings. This commit fixes basically everything that can be fixed through that approach. The remaining tables that give warnings either are scheduled for redesign as per recent discussions, or need a fundamental rethink because they Just Don't Work in a narrow view.
2020-05-05doc: PG 13 relnotes, fix markupBruce Momjian
2020-05-05doc: PG 13 renotes: adjust attribution and pgbench itemBruce Momjian
2020-05-05doc: PG 13 relnotes, add pgbench script itemBruce Momjian
2020-05-05doc: PG 13 relnotes, add attributions and wording changesBruce Momjian
2020-05-05Doc: warn that timezone abbreviations don't work in recovery_target_time.Tom Lane
Moving this setting into the main configuration file was ill-considered, perhaps, because that typically causes it to be set before timezone_abbreviations has been set. Which in turn means that zone abbreviations don't work, only full zone names. We could imagine hacking things so that such cases do work, but the stability of the hack would be questionable, and the value isn't really that high. Instead just document that you should use a numeric zone offset or a full zone name. Per bug #16404 from Reijo Suhonen. Back-patch to v12 where this was changed. Discussion: https://postgr.es/m/16404-4603a99603fbd04c@postgresql.org
2020-05-05doc: PG 13 release note adjustments, Justin Pryzby v2Bruce Momjian
Reported-by: Justin Pryzby
2020-05-05doc: PG 13 retnote adjustmentsBruce Momjian
Reported-by: Justin Pryzby
2020-05-05doc: normalize contributor names in PG 13 release notesBruce Momjian
2020-05-05doc: update PG 13 release notes for glossary and NO DEPENDSBruce Momjian
2020-05-05doc: Fix PG 13 release note markupBruce Momjian
2020-05-05doc: update PG 13 release notes after first draftBruce Momjian
Minor corrections from individuals.
2020-05-05Doc: Outline REPLICATION before SUPERUSER privilegeMichael Paquier
The following docs are updated: - High-availaility section - pg_basebackup - pg_receivewal Per the principle of least privilege, we want to encourage users to interact with those areas using roles that have replication rights, but superusers were mentioned first. Author: Daniel Gustafsson Reviewed-by: Fujii Masao, Michael Paquier Discussion: https://postgr.es/m/ECEBD212-7101-41EB-84F3-2F356E4B6401@yesql.se
2020-05-04doc: first draft of PG 13 release notesBruce Momjian
This still needs markup, indenting, and word wrap.
2020-05-05Change the display of WAL usage statistics in Explain.Amit Kapila
In commit 33e05f89c5, we have added the option to display WAL usage statistics in Explain and auto_explain. The display format used two spaces between each field which is inconsistent with Buffer usage statistics which is using one space between each field. Change the format to make WAL usage statistics consistent with Buffer usage statistics. This commit also changed the usage of "full page writes" to "full page images" for WAL usage statistics to make it consistent with other parts of code and docs. Author: Julien Rouhaud, Amit Kapila Reviewed-by: Justin Pryzby, Kyotaro Horiguchi and Amit Kapila Discussion: https://postgr.es/m/CAB-hujrP8ZfUkvL5OYETipQwA=e3n7oqHFU=4ZLxWS_Cza3kQQ@mail.gmail.com
2020-05-04Doc: improve PDF presentation of some tables by adjusting column widths.Tom Lane
The PDF toolchain defaults to laying out all columns of a table with equal widths, in contrast to the HTML rendering which automatically varies the column widths to fit the data. In many places, this results in very badly laid-out tables, with lots of useless whitespace in some places and text that overruns its cell in other places. For tables that have reasonably static content, we can improve matters by adding <colspec> entries to hand-assign the column widths. This commit does that for a few of the tables that were worst off; it eliminates close to 200 "contents ... exceed the available area" warnings in an A4 PDF build. I also forced align="left" in these tables, overriding the PDF toolchain's default which is evidently "justify". (The HTML toolchain seems to default to that already.) Anyplace where things are tight enough that we need to worry about this, forced justification tends to look truly awful.
2020-05-04Doc: standardize markup a bit more.Tom Lane
We had a mishmash of <replaceable>, <replaceable class="parameter">, and <parameter> markup for operator/function arguments. Use <parameter> consistently for things that are in fact names of parameters (including OUT parameters), reserving <replaceable> for things that aren't. The latter class includes some made-up-by-the-docs type class names, like "numeric_type", as well as placeholders for arguments that don't have well-defined types. Possibly we could do better with those categories as well, but for the moment I'm content not to have parameter names marked up in different ways in different places. (This commit aligns the earlier sections of chapter 9 with a policy that I'd arrived at while working on commit 1ad23335f, which is why the last few sections need no changes.)
2020-05-04Doc: update sections 9.22 - 9.30 for new function table layout.Tom Lane
With the usual quota of minor and less-minor editorial changes.
2020-05-02Remove pg_xact from pg_stat_reset_slru docsTomas Vondra
This should have been included in 2e08d314ed. Reported-by: Fujii Masao Discussion: https://postgr.es/m/20200119143707.gyinppnigokesjok@development
2020-05-01Doc: update sections 9.17 - 9.21 for new function table layout.Tom Lane
With the usual quota of minor editorial changes.
2020-05-01Improve various aspects of pg_rewind documentationMichael Paquier
The pg_rewind docs currently assert that the state of the target's data directory after rewind is equivalent to the source's data directory. This clarifies the documentation to describe that the base state is further back in time and that the target's data directory will include the current state from the source of any copied blocks since the point of divergence. This commit also improves the section "How It Works": - Describe the update of the pg_control file. - Reorganize the list of files and directories ignored during the rewind. Author: James Coleman Discussion: https://postgr.es/m/CAAaqYe-sgqCos7MXF4XiY8rUPy3CEmaCY9EvfhX-DhPhPBF5_A@mail.gmail.com
2020-04-30Doc: update sections 9.14 - 9.16 for new function table layout.Tom Lane
Minor editorial changes in the first two sections; larger ones in the JSON section.
2020-04-30Rename connection parameters to control min/max SSL protocol version in libpqMichael Paquier
The libpq parameters ssl{max|min}protocolversion are renamed to use underscores, to become ssl_{max|min}_protocol_version. The related environment variables still use the names introduced in commit ff8ca5f that added the feature. Per complaint from Peter Eisentraut (this was also mentioned by me in the original patch review but the issue got discarded). Author: Daniel Gustafsson Reviewed-by: Peter Eisentraut, Michael Paquier Discussion: https://postgr.es/m/b319e449-318d-e691-4997-1327e166fcc4@2ndquadrant.com