database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-09-03 15:22:11 +03:00
Code Activity

Rename 'gmake' to 'make' in docs and recommended commands

Browse Source 
This simplifies the docs and makes it easier to cut/paste command lines.
This commit is contained in:
Bruce Momjian
2014-02-12 17:29:19 -05:00
parent 2a2e40aaaa
commit 2fc80e8e83
23 changed files with 96 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/Makefile
View File

@@ -234,9 +234,9 @@ INSTALL.html: standalone-install.sgml installation.sgml version.sgml
## XSLT processing
##
# For obscure reasons, gmake 3.81 complains about circular dependencies
# For obscure reasons, GNU make 3.81 complains about circular dependencies
# if we try to do "make all" in a VPATH build without the explicit
# $(srcdir) on the postgres.sgml dependency in this rule. gmake bug?
# $(srcdir) on the postgres.sgml dependency in this rule. GNU make bug?
postgres.xml: $(srcdir)/postgres.sgml $(ALMOSTALLSGML)
$(OSX) -D. -x lower -i include-xslt-index $< >postgres.xmltmp
$(PERL) -p -e 's/\[(aacute|acirc|aelig|agrave|amp|aring|atilde|auml|bull|copy|eacute|egrave|gt|iacute|lt|mdash|nbsp|ntilde|oacute|ocirc|oslash|ouml|pi|quot|scaron|uuml) *\]/\&\1;/gi;' \

8
doc/src/sgml/contrib.sgml
View File

@@ -26,8 +26,8 @@
(see <xref linkend="build">).
You can build and install all of them by running:
<screen>
<userinput>gmake</userinput>
<userinput>gmake install</userinput>
<userinput>make</userinput>
<userinput>make install</userinput>
</screen>
in the <literal>contrib</literal> directory of a configured source tree;
or to build and install
@@ -35,11 +35,11 @@
Many of the modules have regression tests, which can be executed by
running:
<screen>
<userinput>gmake check</userinput>
<userinput>make check</userinput>
</screen>
before installation or
<screen>
<userinput>gmake installcheck</userinput>
<userinput>make installcheck</userinput>
</screen>
once you have a <productname>PostgreSQL</> server running.
</para>

22
doc/src/sgml/docguide.sgml
View File

@@ -581,7 +581,7 @@ checking for osx... osx
<para>
To build the <acronym>HTML</acronym> version of the documentation:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake html</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make html</userinput>
</screen>
This is also the default target. The output appears in the
subdirectory <filename>html</filename>.
@@ -592,14 +592,14 @@ checking for osx... osx
stages. If you do not care about the index, and just want to
proof-read the output, use <literal>draft</>:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake draft</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make draft</userinput>
</screen>
</para>
<para>
To build the documentation as a single HTML page, use:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres.html</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres.html</userinput>
</screen>
</para>
</sect2>
@@ -616,7 +616,7 @@ checking for osx... osx
pages, use the commands:
<programlisting>
cd doc/src/sgml
gmake man
make man
</programlisting>
</para>
</sect2>
@@ -634,11 +634,11 @@ gmake man
<para>
To generate PostScript via <acronym>DVI</acronym> in A4 format:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres-A4.ps</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-A4.ps</userinput>
</screen>
In U.S. letter format:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres-US.ps</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-US.ps</userinput>
</screen>
</para>
</listitem>
@@ -647,11 +647,11 @@ gmake man
<para>
To make a <acronym>PDF</acronym>:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres-A4.pdf</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-A4.pdf</userinput>
</screen>
or:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres-US.pdf</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-US.pdf</userinput>
</screen>
(Of course you can also make a <acronym>PDF</acronym> version
from the PostScript, but if you generate <acronym>PDF</acronym>
@@ -741,7 +741,7 @@ save_size.pdfjadetex = 15000
<para>
Generate the <acronym>RTF</acronym> version by typing:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake postgres.rtf</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make postgres.rtf</userinput>
</screen>
</para>
</step>
@@ -948,7 +948,7 @@ save_size.pdfjadetex = 15000
corresponds to <xref linkend="installation">, with some minor
changes to account for the different context. To recreate the
file, change to the directory <filename>doc/src/sgml</filename>
and enter <userinput>gmake INSTALL</userinput>.
and enter <userinput>make INSTALL</userinput>.
</para>
<para>
@@ -966,7 +966,7 @@ save_size.pdfjadetex = 15000
method to just check the correct syntax of the documentation
files, which only takes a few seconds:
<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake check</userinput>
<prompt>doc/src/sgml$ </prompt><userinput>make check</userinput>
</screen>
</para>
</sect2>

67
doc/src/sgml/installation.sgml
View File

@@ -32,9 +32,9 @@ in a standalone-ignore clause.
<para>
<synopsis>
./configure
gmake
make
su
gmake install
make install
adduser postgres
mkdir /usr/local/pgsql/data
chown postgres /usr/local/pgsql/data
@@ -77,14 +77,11 @@ su - postgres
<acronym>GNU</> <application>make</> version 3.80 or newer is required; other
<application>make</> programs or older <acronym>GNU</> <application>make</> versions will <emphasis>not</> work.
<acronym>GNU</> <application>make</> is often installed under
the name <filename>gmake</filename>; this document will always
refer to it by that name. (On some systems
<acronym>GNU</acronym> <application>make</> is the default tool with the name
<filename>make</>.) To test for <acronym>GNU</acronym>
(<acronym>GNU</> <application>make</> is sometimes installed under
the name <filename>gmake</filename>.) To test for <acronym>GNU</acronym>
<application>make</application> enter:
<screen>
<userinput>gmake --version</userinput>
<userinput>make --version</userinput>
</screen>
</para>
</listitem>
@@ -422,7 +419,7 @@ su - postgres
<userinput>mkdir build_dir</userinput>
<userinput>cd build_dir</userinput>
<userinput>/path/to/source/tree/configure [options go here]</userinput>
<userinput>gmake</userinput>
<userinput>make</userinput>
</screen>
</para>
@@ -1441,7 +1438,7 @@ su - postgres
source code lines. If you get confused while trying to debug
optimized code, recompile the specific files of interest with
<option>-O0</>. An easy way to do this is by passing an option
to <application>make</>: <command>gmake PROFILE=-O0 file.o</>.
to <application>make</>: <command>make PROFILE=-O0 file.o</>.
</para>
</note>
</step>
@@ -1452,7 +1449,7 @@ su - postgres
<para>
To start the build, type:
<screen>
<userinput>gmake</userinput>
<userinput>make</userinput>
</screen>
(Remember to use <acronym>GNU</> <application>make</>.) The build
will take a few minutes depending on your
@@ -1467,7 +1464,7 @@ All of PostgreSQL is successfully made. Ready to install.
documentation (HTML and man pages), and the additional modules
(<filename>contrib</filename>), type instead:
<screen>
<userinput>gmake world</userinput>
<userinput>make world</userinput>
</screen>
The last line displayed should be:
<screen>
@@ -1490,7 +1487,7 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
runs on your machine in the way the developers expected it
to. Type:
<screen>
<userinput>gmake check</userinput>
<userinput>make check</userinput>
</screen>
(This won't work as root; do it as an unprivileged user.)
<![%standalone-include[The file
@@ -1518,7 +1515,7 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
<para>
To install <productname>PostgreSQL</> enter:
<screen>
<userinput>gmake install</userinput>
<userinput>make install</userinput>
</screen>
This will install files into the directories that were specified
in <xref linkend="configure">. Make sure that you have appropriate
@@ -1531,21 +1528,21 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
<para>
To install the documentation (HTML and man pages), enter:
<screen>
<userinput>gmake install-docs</userinput>
<userinput>make install-docs</userinput>
</screen>
</para>
<para>
If you built the world above, type instead:
<screen>
<userinput>gmake install-world</userinput>
<userinput>make install-world</userinput>
</screen>
This also installs the documentation.
</para>
<para>
You can use <literal>gmake install-strip</literal> instead of
<literal>gmake install</literal> to strip the executable files and
You can use <literal>make install-strip</literal> instead of
<literal>make install</literal> to strip the executable files and
libraries as they are installed. This will save some space. If
you built with debugging support, stripping will effectively
remove the debugging support, so it should only be done if
@@ -1560,7 +1557,7 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
The standard installation provides all the header files needed for client
application development as well as for server-side program
development, such as custom functions or data types written in C.
(Prior to <productname>PostgreSQL</> 8.0, a separate <literal>gmake
(Prior to <productname>PostgreSQL</> 8.0, a separate <literal>make
install-all-headers</> command was needed for the latter, but this
step has been folded into the standard install.)
</para>
@@ -1571,10 +1568,10 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
If you want to install only the client applications and
interface libraries, then you can use these commands:
<screen>
<userinput>gmake -C src/bin install</>
<userinput>gmake -C src/include install</>
<userinput>gmake -C src/interfaces install</>
<userinput>gmake -C doc install</>
<userinput>make -C src/bin install</>
<userinput>make -C src/include install</>
<userinput>make -C src/interfaces install</>
<userinput>make -C doc install</>
</screen>
<filename>src/bin</> has a few binaries for server-only use,
but they are small.
@@ -1586,7 +1583,7 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
<formalpara>
<title>Uninstallation:</title>
<para>
To undo the installation use the command <command>gmake
To undo the installation use the command <command>make
uninstall</>. However, this will not remove any created directories.
</para>
</formalpara>
@@ -1596,11 +1593,11 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
<para>
After the installation you can free disk space by removing the built
files from the source tree with the command <command>gmake
files from the source tree with the command <command>make
clean</>. This will preserve the files made by the <command>configure</command>
program, so that you can rebuild everything with <command>gmake</>
program, so that you can rebuild everything with <command>make</>
later on. To reset the source tree to the state in which it was
distributed, use <command>gmake distclean</>. If you are going to
distributed, use <command>make distclean</>. If you are going to
build for several platforms within the same source tree you must do
this and re-configure for each platform. (Alternatively, use
a separate build tree for each platform, so that the source tree
@@ -1612,7 +1609,7 @@ PostgreSQL, contrib and HTML documentation successfully made. Ready to install.
If you perform a build and then discover that your <command>configure</>
options were wrong, or if you change anything that <command>configure</>
investigates (for example, software upgrades), then it's a good
idea to do <command>gmake distclean</> before reconfiguring and
idea to do <command>make distclean</> before reconfiguring and
rebuilding. Without this, your changes in configuration choices
might not propagate everywhere they need to.
</para>
@@ -1904,7 +1901,7 @@ kill `cat /usr/local/pgsql/data/postmaster.pid`
<listitem>
<para>
Run the regression tests against the installed server (using
<command>gmake installcheck</command>). If you didn't run the
<command>make installcheck</command>). If you didn't run the
tests before installation, you should definitely do it now. This
is also explained in the documentation.
</para>
@@ -2358,12 +2355,6 @@ createlang: language installation failed: ERROR: could not load library "/opt/d
</para>
</listitem>
<listitem>
<para>
The GNU make command is called <command>make</command>, not <command>gmake</command>.
</para>
</listitem>
<listitem>
<para>
The <command>adduser</command> command is not supported; use
@@ -2647,9 +2638,7 @@ PHSS_30849 s700_800 u2comp/be/plugin library Patch
<para>
You need to use the GNU Make program, which is on the Skunkware
CD. By default, it installs
as <filename>/usr/local/bin/make</filename>. To avoid confusion
with the SCO <filename>make</filename> program, you may want to rename GNU <filename>make</filename> to
<filename>gmake</filename>.
as <filename>/usr/local/bin/make</filename>.
</para>
<para>
@@ -2902,7 +2891,7 @@ AbortTransaction utils/probes.o
CommitTransaction utils/probes.o
ld: fatal: Symbol referencing errors. No output written to postgres
collect2: ld returned 1 exit status
gmake: *** [postgres] Error 1
make: *** [postgres] Error 1
</screen>
your DTrace installation is too old to handle probes in static
functions. You need Solaris 10u4 or newer.

4
doc/src/sgml/nls.sgml
View File

@@ -165,7 +165,7 @@ msgstr "another translated"
If you need to start a new translation effort, then first run the
command:
<programlisting>
gmake init-po
make init-po
</programlisting>
This will create a file
<filename><replaceable>progname</replaceable>.pot</filename>.
@@ -188,7 +188,7 @@ AVAIL_LANGUAGES := de fr
changed or added by the programmers. In this case you do not need
to start from scratch. Instead, run the command:
<programlisting>
gmake update-po
make update-po
</programlisting>
which will create a new blank message catalog file (the pot file
you started with) and will merge it with the existing PO files.

2
doc/src/sgml/pgupgrade.sgml
View File

@@ -246,7 +246,7 @@ mv /usr/local/pgsql /usr/local/pgsql.old
location, use the <literal>prefix</literal> variable:
<programlisting>
gmake prefix=/usr/local/pgsql.new install
make prefix=/usr/local/pgsql.new install
</programlisting></para>
</step>

42
doc/src/sgml/regress.sgml
View File

@@ -39,7 +39,7 @@
To run the parallel regression tests after building but before installation,
type:
<screen>
gmake check
make check
</screen>
in the top-level directory. (Or you can change to
<filename>src/test/regress</filename> and run the command there.)
@@ -69,7 +69,7 @@ gmake check
<prompt>root# </prompt><userinput>chmod -R a+w src/test/regress</userinput>
<prompt>root# </prompt><userinput>su - joeuser</userinput>
<prompt>joeuser$ </prompt><userinput>cd <replaceable>top-level build directory</></userinput>
<prompt>joeuser$ </prompt><userinput>gmake check</userinput>
<prompt>joeuser$ </prompt><userinput>make check</userinput>
</screen>
(The only possible <quote>security risk</quote> here is that other
users might be able to alter the regression test results behind
@@ -82,7 +82,7 @@ gmake check
<para>
If you have configured <productname>PostgreSQL</productname> to install
into a location where an older <productname>PostgreSQL</productname>
installation already exists, and you perform <literal>gmake check</>
installation already exists, and you perform <literal>make check</>
before installing the new version, you might find that the tests fail
because the new programs try to use the already-installed shared
libraries. (Typical symptoms are complaints about undefined symbols.)
@@ -103,7 +103,7 @@ gmake check
a position to raise the limit, you can cut down the degree of parallelism
by setting the <literal>MAX_CONNECTIONS</> parameter. For example:
<screen>
gmake MAX_CONNECTIONS=10 check
make MAX_CONNECTIONS=10 check
</screen>
runs no more than ten tests concurrently.
</para>
@@ -117,11 +117,11 @@ gmake MAX_CONNECTIONS=10 check
initialize a data area and start the
server, <![%standalone-ignore;[as explained in <xref linkend="runtime">, ]]> then type:
<screen>
gmake installcheck
make installcheck
</screen>
or for a parallel test:
<screen>
gmake installcheck-parallel
make installcheck-parallel
</screen>
The tests will expect to contact the server at the local host and the
default port number, unless directed otherwise by <envar>PGHOST</envar> and
@@ -138,14 +138,14 @@ gmake installcheck-parallel
built and installed, change to the <filename>src/pl</> directory of the
build tree and type:
<screen>
gmake installcheck
make installcheck
</screen>
You can also do this in any of the subdirectories of <filename>src/pl</>
to run tests for just one procedural language. To run the tests for all
<filename>contrib</> modules that have them, change to the
<filename>contrib</> directory of the build tree and type:
<screen>
gmake installcheck
make installcheck
</screen>
The <filename>contrib</> modules must have been built and installed first.
You can also do this in a subdirectory of <filename>contrib</> to run
@@ -184,7 +184,7 @@ psql -h primary -f src/test/regress/sql/hs_primary_setup.sql regression
directory:
<screen>
cd src/test/regress
gmake standbycheck
make standbycheck
</screen>
</para>
@@ -209,8 +209,8 @@ gmake standbycheck
can be useful to test different locales by setting the appropriate
environment variables, for example:
<screen>
gmake check LANG=C
gmake check LC_COLLATE=en_US.utf8 LC_CTYPE=fr_CA.utf8
make check LANG=C
make check LC_COLLATE=en_US.utf8 LC_CTYPE=fr_CA.utf8
</screen>
For implementation reasons, setting <envar>LC_ALL</envar> does not
work for this purpose; all the other locale-related environment
@@ -227,7 +227,7 @@ gmake check LC_COLLATE=en_US.utf8 LC_CTYPE=fr_CA.utf8
You can also choose the database encoding explicitly by setting
the variable <envar>ENCODING</envar>, for example:
<screen>
gmake check LANG=C ENCODING=EUC_JP
make check LANG=C ENCODING=EUC_JP
</screen>
Setting the database encoding this way typically only makes sense
if the locale is C; otherwise the encoding is chosen automatically
@@ -251,11 +251,11 @@ gmake check LANG=C ENCODING=EUC_JP
files by setting the variable <envar>EXTRA_TESTS</envar>. For
example, to run the <literal>numeric_big</literal> test:
<screen>
gmake check EXTRA_TESTS=numeric_big
make check EXTRA_TESTS=numeric_big
</screen>
To run the collation tests:
<screen>
gmake check EXTRA_TESTS=collate.linux.utf8 LANG=en_US.utf8
make check EXTRA_TESTS=collate.linux.utf8 LANG=en_US.utf8
</screen>
The <literal>collate.linux.utf8</> test works only on Linux/glibc
platforms, and only when run in a database that uses UTF-8 encoding.
@@ -337,7 +337,7 @@ gmake check EXTRA_TESTS=collate.linux.utf8 LANG=en_US.utf8
locale-related environment variables on
the <command>make</command> command line, for example:
<programlisting>
gmake check LANG=de_DE.utf8
make check LANG=de_DE.utf8
</programlisting>
(The regression test driver unsets <envar>LC_ALL</envar>, so it
does not work to choose the locale using that variable.) To use
@@ -345,7 +345,7 @@ gmake check LANG=de_DE.utf8
(or set them to <literal>C</literal>) or use the following
special invocation:
<programlisting>
gmake check NO_LOCALE=1
make check NO_LOCALE=1
</programlisting>
When running the tests against an existing installation, the
locale setup is determined by the existing installation. To
@@ -601,19 +601,19 @@ float8:out:i.86-.*-openbsd=float8-small-is-zero.out
A typical workflow would look like this:
<screen>
./configure --enable-coverage ... OTHER OPTIONS ...
gmake
gmake check # or other test suite
gmake coverage-html
make
make check # or other test suite
make coverage-html
</screen>
Then point your HTML browser
to <filename>coverage/index.html</filename>.
The <command>gmake</command> commands also work in subdirectories.
The <command>make</command> commands also work in subdirectories.
</para>
<para>
To reset the execution counts between test runs, run:
<screen>
gmake coverage-clean
make coverage-clean
</screen>
</para>
</sect1>

2
doc/src/sgml/release-8.3.sgml
View File

@@ -8297,7 +8297,7 @@ current_date &lt; 2017-11-17
<listitem>
<para>
Support <command>gmake draft</command> when building the
Support <command>make draft</command> when building the
<acronym>SGML</> documentation (Bruce)
</para>

2
doc/src/sgml/release-9.2.sgml
View File

@@ -5434,7 +5434,7 @@
</para>
<para>
Use <command>gmake STYLE=website draft</>.
Use <command>make STYLE=website draft</>.
</para>
</listitem>