doc/src/sgml/release.sgml

   1 <!-- doc/src/sgml/release.sgml -->
   2 <!--
   3
   4 Typical markup:
   5
   6 &<>                             use & escapes
   7 PostgreSQL                      <productname>
   8 postgresql.conf, pg_hba.conf    <filename>
   9 \<[A-Z][A-Z_ ]+[A-Z_]\>         <command>, <literal>, <envar>, <acronym>
  10 \<[A-Za-z_][A-Za-z0-9_]+()      <function>
  11 \-\-?[A-Za-z_]+[-A-Za-z_]*      <option> (use backslashes to avoid SGML markup)
  12 \<[A-Za-z_]+/[A-Za-z_]+\>       <filename>
  13 psql                            <application>
  14 pg_[A-Za-z0-9_]+                <application>, <structname>
  15 \<[A-Z][A-Z][A-Z_ ]*\>          <type>
  16 \<[a-z]+_[a-z_]+\>              <varname>, <structfield>
  17                                 <systemitem class="osname">
  18
  19 non-ASCII characters            find using grep -P '[\x80-\xFF]' or
  20                                   (remove 'X') grep -X-color='auto' -P -n "[\x80-\xFF]"
  21                                 convert to HTML4 named entity (&) escapes
  22
  23         official:      http://www.w3.org/TR/html4/sgml/entities.html
  24         one page:      http://www.zipcon.net/~swhite/docs/computers/browsers/entities_page.html
  25         other lists:   http://www.zipcon.net/~swhite/docs/computers/browsers/entities.html
  26                        http://www.zipcon.net/~swhite/docs/computers/browsers/entities_page.html
  27                        https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
  28
  29         We cannot use UTF8 because rendering engines have to
  30         support the referenced characters.
  31
  32         Do not use numeric _UTF_ numeric character escapes (&#nnn;),
  33         we can only use Latin1.
  34
  35         Example: Alvaro Herrera is &Aacute;lvaro Herrera
  36
  37 wrap long lines
  38
  39 For new features, add links to the documentation sections.
  40
  41 -->
  42
  43 <appendix id="release">
  44  <title>Release Notes</title>
  45
  46   <para>
  47    The release notes contain the significant changes in each
  48    <productname>PostgreSQL</productname> release, with major features and migration
  49    issues listed at the top.  The release notes do not contain changes
  50    that affect only a few users or changes that are internal and therefore not
  51    user-visible.  For example, the optimizer is improved in almost every
  52    release, but the improvements are usually observed by users as simply
  53    faster queries.
  54   </para>
  55
  56   <para>
  57    A complete list of changes for each release can be obtained by
  58    viewing the <link linkend="git">Git</link> logs for each release.
  59    The <ulink
  60    url="https://www.postgresql.org/list/pgsql-committers/"><literal>pgsql-committers</literal>
  61    email list</ulink> records all source code changes as well.  There is also
  62    a <ulink url="https://git.postgresql.org/gitweb/?p=postgresql.git;a=summary">web
  63    interface</ulink> that shows changes to specific files.
  64   </para>
  65
  66   <para>
  67    The name appearing next to each item represents the major developer for
  68    that item.  Of course all changes involve community discussion and patch
  69    review, so each item is truly a community effort.
  70   </para>
  71
  72 <!--
  73   When beginning a new major-release series, create a new release-NN.sgml
  74   file, removing the previous one, and change the &-reference here.
  75   Don't forget to update filelist.sgml.
  76
  77   The reason for keeping each branch's release notes in a differently-named
  78   file is to reduce confusion when preparing minor-release updates.
  79   All the active branches have to be edited concurrently when doing that.
  80 -->
  81
  82 &release-18;
  83
  84  <sect1 id="release-prior">
  85   <title>Prior Releases</title>
  86
  87   <para>
  88    Release notes for prior release branches can be found at
  89    <ulink url="https://www.postgresql.org/docs/release/"><literal>https://www.postgresql.org/docs/release/</literal></ulink>
  90   </para>
  91  </sect1>
  92
  93 </appendix>