Documentation for postgresql.port.mk.
authorzhuk <zhuk@openbsd.org>
Mon, 12 Jan 2015 20:56:20 +0000 (20:56 +0000)
committerzhuk <zhuk@openbsd.org>
Mon, 12 Jan 2015 20:56:20 +0000 (20:56 +0000)
share/man/man5/port-modules.5

index 639083d..7e694b7 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: port-modules.5,v 1.183 2014/09/13 16:30:05 ajacoutot Exp $
+.\"    $OpenBSD: port-modules.5,v 1.184 2015/01/12 20:56:20 zhuk Exp $
 .\"
 .\" Copyright (c) 2008 Marc Espie
 .\"
@@ -24,7 +24,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: September 13 2014 $
+.Dd $Mdocdate: January 12 2015 $
 .Dt PORT-MODULES 5
 .Os
 .Sh NAME
@@ -433,6 +433,43 @@ post-install:
        ...
        ${MODCPAN_POST_INSTALL}
 .Ed
+.It databases/postgresql
+Adds small framework for testing ports that require running Postgres.
+Defines
+.Ev MODPOSTGRESQL_TEST_TARGET
+which consists actual commands to run in
+.Ar do-test
+target.
+If this target isn't defined, it will be added automatically.
+.Pp
+The actual test command to be run could be specified in the
+.Ev MODPOSTGRESQL_TEST_CMD .
+Default is similar to what
+.Xr bsd.port.mk 5
+runs itself.
+.Pp
+The Postgres server being started will listen on UNIX domain socket
+only, minimizing impact on running system.
+The path to directory where socket will be created is set by
+.Ev MODPOSTGRESQL_TEST_PGHOST ,
+defaulting to
+.Pa ${WRKDIR} .
+Any local user will be able to connect without password.
+.Pp
+If the
+.Ev MODPOSTGRESQL_TEST_DBNAME
+variable is set, the database with such name will be set up before 
+running actual test command.
+Otherwise (default), the test is responsible to call
+.Xr initdb 1
+itself.
+.Pp
+The
+.Pa databases/postgresql,-server
+will get added to
+.Ev TEST_DEPENDS ,
+but not to any other
+.Ev *_DEPENDS .
 .It devel/cmake
 Adds
 .Pa devel/cmake