svn commit: r48737 - in head/en_US.ISO8859-1/books/porters-handbook: special uses

Mathieu Arnold <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
Author: mat
Date: Wed Apr 27 13:55:31 2016
New Revision: 48737
URL: https://svnweb.freebsd.org/changeset/doc/48737

Log:
  Document the recent bsd.databases.mk changes.
  
  - SQLite has been USES=sqlite for a long time.
  - USE_BDB is now USES=bdb.
  - USE_MYSQL is now USES=mysql.
  
  Reviewed by:	wblock
  Sponsored by:	Absolight
  Differential Revision:	https://reviews.freebsd.org/D6123

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
  head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Tue Apr 26 13:00:32 2016	(r48736)
+++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Wed Apr 27 13:55:31 2016	(r48737)
@@ -5177,46 +5177,27 @@ USE_XFCE=	libexo libmenu libutil panel</
 
 	<tbody>
 	  <row>
-	    <entry><varname>USE_BDB</varname></entry>
-	    <entry>If variable is set to <literal>yes</literal>,
-	      add dependency on
-	      <package role="port">databases/db5</package>
-	      port.  The variable may also be set to values: 48, 5
-	      or 6.  It is possible to declare a range of acceptable
-	      values, <varname>USE_BDB</varname>=48+ will find the
-	      highest installed version, and fall back to 4.8 if
-	      nothing else is installed.
-	      <varname>WANT_BDB_VER</varname> will always build this
-	      port with a specific version of the Berkely DB.
-	      <varname>INVALID_BDB_VER</varname> can be used to
-	      specify a version that cannot be used.</entry>
+	    <entry>USE_BDB</entry>
+	    <entry>Obsolete.  Replaced by <link
+		linkend="uses-bdb"><literal>USES=bdb</literal></link></entry>
 	  </row>
 
 	  <row>
 	    <entry><varname>USE_MYSQL</varname></entry>
-	    <entry>If the variable is set to <literal>yes</literal>,
-	      add a dependency on the <package
-		role="port">databases/mysql56-client</package> port.
-	      An associated variable,
-	      <varname>WANT_MYSQL_VER</varname>, may be set to
-	      values such as 51, 55, or 60.  Additionally to
-	      specify use of Percona, use 56p, or for MariaDB, use
-	      53m, 55m or 100m.</entry>
+	    <entry>Obsolete.  Replaced by <link
+		linkend="uses-mysql"><literal>USES=mysql</literal></link></entry>
 	  </row>
 
 	  <row>
 	    <entry><varname>USE_PGSQL</varname></entry>
-	    <entry>Retired in favor of <link
+	    <entry>Obsolete.  Replaced by <link
 		linkend="uses-pgsql"><literal>USES=pgsql</literal></link>.</entry>
 	  </row>
 
 	  <row>
 	    <entry><varname>USE_SQLITE</varname></entry>
-	    <entry>If set to <literal>yes</literal>, add
-	      dependency on
-	      <package role="port">databases/sqlite3</package>
-	      port.  The variable may also be set to 3 or 2, to add
-	      a dependency on 3.x or 2.x, respectively.</entry>
+	    <entry>Obsolete.  Replaced by <link
+		linkend="uses-sqlite"><literal>USES=sqlite</literal></link></entry>
 	  </row>
 	</tbody>
       </tgroup>

Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Tue Apr 26 13:00:32 2016	(r48736)
+++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Wed Apr 27 13:55:31 2016	(r48737)
@@ -136,6 +136,92 @@
     <para>Adds dependencies on Blas / Lapack libraries.</para>
   </sect1>
 
+  <sect1 xml:id="uses-bdb">
+    <title><literal>bdb</literal></title>
+
+    <para>Possible arguments: (none), <literal>48</literal>,
+      <literal>5</literal> (default), <literal>6</literal></para>
+
+    <para>Add dependency on the <application>Berkeley DB</application>
+	library.  Default to <package
+	  role="port">databases/db5</package>.  It can also depend on
+	<package role="port">databases/db48</package> when using the
+	<literal>:48</literal> argument or <package
+	  role="port">databases/db6</package> with
+	<literal>:6</literal>.  It is possible to declare a range of
+	acceptable values, <literal>:48+</literal> finds the highest
+	installed version, and falls back to 4.8 if nothing else is
+	installed.  <varname>INVALID_BDB_VER</varname> can be used to
+	specify versions which do not work with this port.  The
+	framework exposes the following variables to the port:</para>
+
+    <variablelist>
+      <varlistentry>
+	<term><varname>BDB_LIB_NAME</varname></term>
+
+	<listitem>
+	  <para>The name of the <application>Berkeley DB</application>
+	    library.  For example, when using <package
+	      role="port">databases/db5</package>, it contains
+	    <literal>db-5.3</literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname>BDB_LIB_CXX_NAME</varname></term>
+
+	<listitem>
+	  <para>The name of the <application>Berkeley DB</application>
+	    <application>C++</application> library.  For example, when
+	    using <package role="port">databases/db5</package>, it
+	    contains <literal>db_cxx-5.3</literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname>BDB_INCLUDE_DIR</varname></term>
+
+	<listitem>
+	  <para>The location of the <application>Berkeley
+	      DB</application> include directory.  For example, when
+	    using <package role="port">databases/db5</package>, it
+	    will contain
+	    <literal>${LOCALBASE}/include/db5</literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname>BDB_LIB_DIR</varname></term>
+
+	<listitem>
+	  <para>The location of the <application>Berkeley
+	      DB</application> library directory.  For example, when
+	    using <package role="port">databases/db5</package>, it
+	    contains <literal>${LOCALBASE}/lib</literal>.</para>
+	</listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><varname>BDB_VER</varname></term>
+
+	<listitem>
+	  <para>The detected <application>Berkeley DB</application>
+	    version.  For example, if using
+	    <literal>USES=bdb:48+</literal> and <application>Berkeley
+	      DB</application> 5 is installed, it contains
+	    <literal>5</literal>.</para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+
+    <important>
+      <para><package role="port">databases/db48</package> is
+	deprecated and unsupported.  It must not be used by any
+	port.</para>
+    </important>
+  </sect1>
+
   <sect1 xml:id="uses-bison">
     <title><literal>bison</literal></title>
 
@@ -1427,6 +1513,33 @@ USE_MATE=	menus:build intlhack</programl
       <varname>NO_MTREE</varname>, <varname>NO_ARCH</varname>.</para>
   </sect1>
 
+  <sect1 xml:id="uses-mysql">
+    <title><literal>mysql</literal></title>
+
+    <para>Possible arguments: (none),
+      <literal><replaceable>version</replaceable></literal>,
+      <literal>server</literal>, <literal>embedded</literal></para>
+
+    <para>Provide support for <application>MySQL</application>.  If no
+      version is given, try to find the current installed version.
+      Fall back to the default version, MySQL-5.6.  The possible
+      versions are <literal>55</literal>, <literal>55m</literal>,
+      <literal>55p</literal>, <literal>56</literal>,
+      <literal>56p</literal>, <literal>57</literal>,
+      <literal>100m</literal>, and <literal>101m</literal>.  The
+      <literal>m</literal> and <literal>p</literal> suffixes are for
+      the <application>MariaDB</application> and
+      <application>Percona</application> variants of
+      <application>MySQL</application>.  <literal>server</literal> and
+      <literal>embedded</literal> add a build- and run-time dependency
+      on the <application>MySQL</application> server.  A port can set
+      <varname>IGNORE_WITH_MYSQL</varname> if some versions are not
+      supported.</para>
+
+    <para>The framework sets <varname>MYSQL_VER</varname> to the
+      detected MySQL version.</para>
+  </sect1>
+
   <sect1 xml:id="uses-mono">
     <title><literal>mono</literal></title>
 
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "[email protected]"
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.