1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-19 17:02:53 +03:00
Files
postgres/doc/src/sgml/sourcerepo.sgml
Daniel Gustafsson 172f217e82 doc: Remove mention of Git protocol support
The project Git server hasn't supported cloning with the Git protocol
in a very long time, but the documentation never got the memo. Remove
the mention of using the Git protocol, and while there wrap a mention
of Git in <productname> tags.

Backpatch down to all supported versions.

Author: Daniel Gustafsson <daniel@yesql.se>
Reported-by: Gurjeet Singh <gurjeet@singh.im>
Reviewed-by: Nathan Bossart <nathandbossart@gmail.com>
Reviewed-by: Jacob Champion <jacob.champion@enterprisedb.com>
Reviewed-by: Gurjeet Singh <gurjeet@singh.im>
Reviewed-by: Tom Lane <tgl@sss.pgh.pa.us>
Discussion: https://postgr.es/m/CABwTF4WMiMb-KT2NRcib5W0C8TQF6URMb+HK9a_=rnZnY8Q42w@mail.gmail.com
Backpatch-through: 13
2025-10-23 21:26:15 +02:00

76 lines
2.3 KiB
Plaintext

<!-- doc/src/sgml/sourcerepo.sgml -->
<appendix id="sourcerepo">
<title>The Source Code Repository</title>
<para>
The <productname>PostgreSQL</productname> source code is stored and managed
using the <productname>Git</productname> version control system. A public
mirror of the master repository is available; it is updated within a minute
of any change to the master repository.
</para>
<para>
Our wiki, <ulink
url="https://wiki.postgresql.org/wiki/Working_with_Git"></ulink>,
has some discussion on working with Git.
</para>
<sect1 id="git">
<title>Getting the Source via <productname>Git</productname></title>
<para>
With <productname>Git</productname> you will make a copy of the entire code repository
on your local machine, so you will have access to all history and branches
offline. This is the fastest and most flexible way to develop or test
patches.
</para>
<procedure>
<title>Git</title>
<step>
<para>
You will need an installed version of <productname>Git</productname>, which you can
get from <ulink url="https://git-scm.com"></ulink>. Many systems already
have a recent version of <application>Git</application> installed by default, or
available in their package distribution system.
</para>
</step>
<step>
<para>
To begin using the <productname>Git</productname> repository, make a clone of the official mirror:
<programlisting>
git clone https://git.postgresql.org/git/postgresql.git
</programlisting>
This will copy the full repository to your local machine, so it may take
a while to complete, especially if you have a slow Internet connection.
The files will be placed in a new subdirectory <filename>postgresql</filename> of
your current directory.
</para>
</step>
<step>
<para>
Whenever you want to get the latest updates in the system, <command>cd</command>
into the repository, and run:
<programlisting>
git fetch
</programlisting>
</para>
</step>
</procedure>
<para>
<productname>Git</productname> can do a lot more things than just fetch the source. For
more information, consult the <productname>Git</productname> man pages, or see the
website at <ulink url="https://git-scm.com"></ulink>.
</para>
</sect1>
</appendix>