Bug 178073 - [patch][porters-handbook]: add pkgconfig to USES, and drop USE_PKGCONFIG
Summary: [patch][porters-handbook]: add pkgconfig to USES, and drop USE_PKGCONFIG
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Eitan Adler
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-04-23 07:50 UTC by Jason Helfman
Modified: 2013-04-24 18:00 UTC (History)
1 user (show)

See Also:


Attachments
file.diff (2.47 KB, patch)
2013-04-23 07:50 UTC, Jason Helfman
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jason Helfman freebsd_committer freebsd_triage 2013-04-23 07:50:00 UTC
add USES= pkgconfig to handbook, and drop USE_PKGCONFIG
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2013-04-24 00:57:51 UTC
Responsible Changed
From-To: freebsd-doc->eadler

I'll take it.
Comment 2 Ben Kaduk 2013-04-24 02:56:02 UTC
On Tue, 23 Apr 2013, eadler@freebsd.org wrote:

> Synopsis: [patch][porters-handbook]: add pkgconfig to USES, and drop USE_PKGCONFIG
>
> Responsible-Changed-From-To: freebsd-doc->eadler
> Responsible-Changed-By: eadler
> Responsible-Changed-When: Tue Apr 23 23:57:51 UTC 2013
> Responsible-Changed-Why:
> I'll take it.
>
> http://www.freebsd.org/cgi/query-pr.cgi?pr=178073

% +  <entry><literal>pkgconfig</literal></entry>
% +  <entry>none, <literal>build</literal>, <literal>run</literal>,
% +    <literal>both</literal></entry>
% +  <entry>Implies that the port uses <filename
% +      role="package">devel/pkgconf</filename> in one way or another.  By
% +    default, with no arguments or with the <literal>build</literal>

This comma seems misplaced; at present it would seem to imply that the 
no-argument or "build" behavior is the default -- logically, the default 
is when no argument is specified and any other case is non-default.  I 
think the comma should go after "arguments".

% +    argument, it implies <command>pkg-config</command> as a build-time
% +    dependency, <literal>run</literal> implies a run-time dependency,

Semicolons to separate list items are worth considering here to reduce 
risk of comma splice.

-Ben

% +    and <literal>both</literal> implies both run-time and build-time
% +    dependencies.</entry>
% +</row>
Comment 3 Eitan Adler freebsd_committer freebsd_triage 2013-04-24 17:31:17 UTC
State Changed
From-To: open->closed

Committed. Thanks!
Comment 4 dfilter service freebsd_committer freebsd_triage 2013-04-24 17:53:18 UTC
Author: eadler
Date: Wed Apr 24 16:53:10 2013
New Revision: 41488
URL: http://svnweb.freebsd.org/changeset/doc/41488

Log:
  Document the pkgconfig USES
  
  PR:		docs/178073
  Submitted by:	jgh
  Reviewed by:	bjk
  Approved by:	bcr

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/book.xml	Wed Apr 24 16:11:15 2013	(r41487)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.xml	Wed Apr 24 16:53:10 2013	(r41488)
@@ -5775,52 +5775,6 @@ CMAKE_SOURCE_PATH=	&dollar;{WRKSRC}/subp
       </sect2>
     </sect1>
 
-    <sect1 id="using-pkg-config">
-      <title>Using <literal>pkg-config</literal></title>
-
-      <para>If your ports requires <literal>pkg-config</literal>,
-	just set <makevar>USE_PKGCONFIG</makevar> to the following
-	possible values:</para>
-      <table frame="none">
-	<title>Values for <makevar>USE_PKGCONFIG</makevar></title>
-
-	<tgroup cols="2">
-	  <thead>
-	    <row>
-	      <entry>Definition</entry>
-	      <entry>Description</entry>
-	    </row>
-	  </thead>
-
-	  <tbody>
-	    <row>
-	      <entry><makevar>USE_PKGCONFIG= yes</makevar></entry>
-	      <entry>The ports uses pkg-config only at build
-		time</entry>
-	    </row>
-
-	    <row>
-	      <entry><makevar>USE_PKGCONFIG= build</makevar></entry>
-	      <entry>The ports uses pkg-config only at build
-		time</entry>
-	    </row>
-
-	    <row>
-	      <entry><makevar>USE_PKGCONFIG= run</makevar></entry>
-	      <entry>The ports uses pkg-config only at run
-		time</entry>
-	    </row>
-
-	    <row>
-	      <entry><makevar>USE_PKGCONFIG= both</makevar></entry>
-	      <entry>The ports uses pkg-config both at build and run
-		time</entry>
-	    </row>
-	  </tbody>
-	</tgroup>
-      </table>
-    </sect1>
-
     <sect1 id="using-gettext">
       <title>Using GNU <literal>gettext</literal></title>
 

Modified: head/en_US.ISO8859-1/books/porters-handbook/uses.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/uses.xml	Wed Apr 24 16:11:15 2013	(r41487)
+++ head/en_US.ISO8859-1/books/porters-handbook/uses.xml	Wed Apr 24 16:53:10 2013	(r41488)
@@ -72,6 +72,21 @@
 </row>
 
 <row>
+  <entry><literal>pkgconfig</literal></entry>
+
+  <entry>none, <literal>build</literal>, <literal>run</literal>,
+    <literal>both</literal></entry>
+
+  <entry>Implies that the port uses <filename
+      role="package">devel/pkgconf</filename> in one way or another.
+    With no arguments or with the <literal>build</literal>
+    argument, it implies <command>pkg-config</command> as a build-time
+    dependency; <literal>run</literal> implies a run-time dependency;
+    and <literal>both</literal> implies both run-time and build-time
+    dependencies.</entry>
+</row>
+
+<row>
   <entry><literal>qmail</literal></entry>
   <entry>none, <literal>build</literal>, <literal>run</literal>,
     <literal>both</literal>, <literal>vars</literal></entry>
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"