Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 26 Aug 2019 09:47:56 +0000 (UTC)
From:      Niclas Zeising <zeising@FreeBSD.org>
To:        doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org
Subject:   svn commit: r53329 - in head/en_US.ISO8859-1/books/porters-handbook: makefiles special uses
Message-ID:  <201908260947.x7Q9luaB043543@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: zeising
Date: Mon Aug 26 09:47:56 2019
New Revision: 53329
URL: https://svnweb.freebsd.org/changeset/doc/53329

Log:
  Update porters handbook for USES=xorg xorg-cat
  
  Update porters handbook to document the new USES=xorg and USES=xorg-cat
  additions.
  
  Reviewed by:	mat
  Differential Revision:	https://reviews.freebsd.org/D20732

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
  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/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Sun Aug 25 19:53:46 2019	(r53328)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Mon Aug 26 09:47:56 2019	(r53329)
@@ -6539,6 +6539,7 @@ SUB_LIST+=	OPT1="@comment " NO_OPT1=""
 	  <emphasis>not</emphasis> selected.   For example:</para>
 
 	<programlisting>OPTIONS_DEFINE=	OPT1
+OPT1_USES=	xorg
 OPT1_USE=	mysql=yes xorg=x11,xextproto,xext,xrandr
 OPT1_USE_OFF=	openssl=yes</programlisting>
 
@@ -6550,6 +6551,7 @@ OPT1_USE_OFF=	openssl=yes</programlisting>
 
 .if ${PORT_OPTIONS:MOPT1}
 USE_MYSQL=	yes
+USES+=		xorg
 USE_XORG=	x11 xextproto xext xrandr
 .else
 USE_OPENSSL=	yes
@@ -7003,6 +7005,7 @@ CONFIGURE_ARGS+=	--disable-opt2
 	  <programlisting>OPTIONS_DEFINE=	X11 GNOME
 OPTIONS_DEFAULT=	X11
 
+X11_USES=	xorg
 X11_USE=	xorg=xi,xextproto
 GNOME_USE=	gnome=gtk30
 GNOME_IMPLIES=	X11</programlisting>

Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Sun Aug 25 19:53:46 2019	(r53328)
+++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Mon Aug 26 09:47:56 2019	(r53329)
@@ -1643,312 +1643,12 @@ USE_PERL5=	modbuildtiny</programlisting>
       <title>X.Org Components</title>
 
       <para>The X11 implementation available in The Ports Collection
-	is X.Org.  If the application depends on X components, set
+	is X.Org.  If the application depends on X components, add
+	<varname>USES=	xorg</varname> and set
 	<varname>USE_XORG</varname> to the list of required
 	components.  A full list can be found in <xref
-	linkend="using-x11-components" />.  An always up-to-date
-	list can be found in
-	<filename>/usr/ports/Mk/bsd.xorg.mk</filename>.</para>
+	linkend="uses-xorg" />.</para>
 
-      <table frame="none" xml:id="using-x11-components">
-	<title>Available X.Org Components</title>
-
-	<tgroup cols="2">
-	  <thead>
-	    <row>
-	      <entry>Name</entry>
-	      <entry>Description</entry>
-	    </row>
-	  </thead>
-
-	  <!-- From any ports checkout, run
-	    for m in $(make -C x11/libX11 -V XORG_MODULES:O); do
-	        port=$(make -C x11/libX11 -V "${m}_LIB_PC_DEPENDS:C/^.*://")
-	        if [ -z "$port" ]; then
-	            port=$(make -C x11/libX11 -V "${m}_BUILD_DEPENDS:C/^.*://")
-	        fi
-	        description=$(make -C "$port" -V COMMENT)
-	        printf "<row>\n<entry><literal>$m</literal></entry>\n<entry>$description</entry>\n</row>\n\n"
-	    done
-	    -->
-	  <tbody>
-	    <row>
-	      <entry><literal>dmx</literal></entry>
-	      <entry>DMX extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>fontenc</literal></entry>
-	      <entry>The fontenc Library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>fontutil</literal></entry>
-	      <entry>Create an index of X font files in a
-		directory</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>ice</literal></entry>
-	      <entry>Inter Client Exchange library for X11</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>libfs</literal></entry>
-	      <entry>The FS library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>oldx</literal></entry>
-	      <entry>Old X library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>pciaccess</literal></entry>
-	      <entry>Generic PCI access library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>pixman</literal></entry>
-	      <entry>Low-level pixel manipulation library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>sm</literal></entry>
-	      <entry>Session Management library for X11</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>x11</literal></entry>
-	      <entry>X11 library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xau</literal></entry>
-	      <entry>Authentication Protocol library for X11</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xaw</literal></entry>
-	      <entry>X Athena Widgets library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xaw6</literal></entry>
-	      <entry>X Athena Widgets library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xaw7</literal></entry>
-	      <entry>X Athena Widgets library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xbitmaps</literal></entry>
-	      <entry>X.Org bitmaps data</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xcb</literal></entry>
-	      <entry>The X protocol C-language Binding (XCB)
-		library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xcomposite</literal></entry>
-	      <entry>X Composite extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xcursor</literal></entry>
-	      <entry>X client-side cursor loading library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xdamage</literal></entry>
-	      <entry>X Damage extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xdmcp</literal></entry>
-	      <entry>X Display Manager Control Protocol
-		library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xevie</literal></entry>
-	      <entry>The Xevie library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xext</literal></entry>
-	      <entry>X11 Extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xfixes</literal></entry>
-	      <entry>X Fixes extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xfont</literal></entry>
-	      <entry>X font library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xfont2</literal></entry>
-	      <entry>X font library version 2.x</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xfontcache</literal></entry>
-	      <entry>The Xfontcache library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xft</literal></entry>
-	      <entry>Client-sided font API for X applications</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xi</literal></entry>
-	      <entry>X Input extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xinerama</literal></entry>
-	      <entry>X11 Xinerama library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xkbfile</literal></entry>
-	      <entry>XKB file library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xkbui</literal></entry>
-	      <entry>The xkbui library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xmu</literal></entry>
-	      <entry>X Miscellaneous Utilities libraries</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xmuu</literal></entry>
-	      <entry>X Miscellaneous Utilities libraries</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xorg-macros</literal></entry>
-	      <entry>X.Org development aclocal macros</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xorg-server</literal></entry>
-	      <entry>X.Org X server and related programs</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xorgproto</literal></entry>
-	      <entry>X.Org protocol headers</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xp</literal></entry>
-	      <entry>X print library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xpm</literal></entry>
-	      <entry>X Pixmap library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xprintapputil</literal></entry>
-	      <entry>The XprintAppUtil library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xprintutil</literal></entry>
-	      <entry>The XprintUtil library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xrandr</literal></entry>
-	      <entry>X Resize and Rotate extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xrender</literal></entry>
-	      <entry>X Render extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xres</literal></entry>
-	      <entry>X Resource usage library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xscrnsaver</literal></entry>
-	      <entry>The XScrnSaver library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xshmfence</literal></entry>
-	      <entry>Shared memory 'SyncFence' synchronization
-		primitive</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xt</literal></entry>
-	      <entry>X Toolkit library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xtrans</literal></entry>
-	      <entry>Abstract network code for X</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xtrap</literal></entry>
-	      <entry>The XTrap library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xtst</literal></entry>
-	      <entry>X Test extension</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xv</literal></entry>
-	      <entry>X Video Extension library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xvmc</literal></entry>
-	      <entry>X Video Extension Motion Compensation
-		library</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xxf86dga</literal></entry>
-	      <entry>X DGA Extension</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xxf86misc</literal></entry>
-	      <entry>X XF86-Misc Extension</entry>
-	    </row>
-
-	    <row>
-	      <entry><literal>xxf86vm</literal></entry>
-	      <entry>X Vidmode Extension</entry>
-	    </row>
-	  </tbody>
-	</tgroup>
-      </table>
 
       <para>The Mesa Project is an effort to provide free OpenGL
 	implementation.  To specify a dependency on various

Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Sun Aug 25 19:53:46 2019	(r53328)
+++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml	Mon Aug 26 09:47:56 2019	(r53329)
@@ -3438,6 +3438,338 @@ BROKEN_SSL_REASON_libressl=	needs features only availa
       <package role="port">x11-wm/xfce4-panel</package>.</para>
   </sect1>
 
+  <sect1 xml:id="uses-xorg">
+    <title><literal>xorg</literal></title>
+
+    <para>Possible arguments: (none)</para>
+
+    <para>Provides an easy way to depend on
+      <application>X.org</application> components.  The components
+      should be listed in <varname>USE_XORG</varname>.  The available
+      components are:</para>
+
+    <table frame="none" xml:id="using-x11-components">
+      <title>Available X.Org Components</title>
+
+      <tgroup cols="2">
+	<thead>
+	  <row>
+	    <entry>Name</entry>
+	    <entry>Description</entry>
+	  </row>
+	</thead>
+
+	<!-- From any ports checkout, run
+	  for m in $(make -C x11/libX11 -V XORG_MODULES:O); do
+	      port=$(make -C x11/libX11 -V "${m}_LIB_PC_DEPENDS:C/^.*://")
+	      if [ -z "$port" ]; then
+	          port=$(make -C x11/libX11 -V "${m}_BUILD_DEPENDS:C/^.*://")
+	      fi
+	      description=$(make -C "$port" -V COMMENT)
+	      printf "<row>\n<entry><literal>$m</literal></entry>\n<entry>$description</entry>\n</row>\n\n"
+	  done
+	  -->
+	<tbody>
+	  <row>
+	    <entry><literal>dmx</literal></entry>
+	    <entry>DMX extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>fontenc</literal></entry>
+	    <entry>The fontenc Library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>fontutil</literal></entry>
+	    <entry>Create an index of X font files in a
+	      directory</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>ice</literal></entry>
+	    <entry>Inter Client Exchange library for X11</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>libfs</literal></entry>
+	    <entry>The FS library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>oldx</literal></entry>
+	    <entry>Old X library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>pciaccess</literal></entry>
+	    <entry>Generic PCI access library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>pixman</literal></entry>
+	    <entry>Low-level pixel manipulation library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>sm</literal></entry>
+	    <entry>Session Management library for X11</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>x11</literal></entry>
+	    <entry>X11 library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xau</literal></entry>
+	    <entry>Authentication Protocol library for X11</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xaw</literal></entry>
+	    <entry>X Athena Widgets library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xaw6</literal></entry>
+	    <entry>X Athena Widgets library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xaw7</literal></entry>
+	    <entry>X Athena Widgets library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xbitmaps</literal></entry>
+	    <entry>X.Org bitmaps data</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xcb</literal></entry>
+	    <entry>The X protocol C-language Binding (XCB)
+	      library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xcomposite</literal></entry>
+	    <entry>X Composite extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xcursor</literal></entry>
+	    <entry>X client-side cursor loading library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xdamage</literal></entry>
+	    <entry>X Damage extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xdmcp</literal></entry>
+	    <entry>X Display Manager Control Protocol
+	      library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xevie</literal></entry>
+	    <entry>The Xevie library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xext</literal></entry>
+	    <entry>X11 Extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xfixes</literal></entry>
+	    <entry>X Fixes extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xfont</literal></entry>
+	    <entry>X font library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xfont2</literal></entry>
+	    <entry>X font library version 2.x</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xfontcache</literal></entry>
+	    <entry>The Xfontcache library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xft</literal></entry>
+	    <entry>Client-sided font API for X applications</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xi</literal></entry>
+	    <entry>X Input extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xinerama</literal></entry>
+	    <entry>X11 Xinerama library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xkbfile</literal></entry>
+	    <entry>XKB file library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xkbui</literal></entry>
+	    <entry>The xkbui library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xmu</literal></entry>
+	    <entry>X Miscellaneous Utilities libraries</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xmuu</literal></entry>
+	    <entry>X Miscellaneous Utilities libraries</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xorg-macros</literal></entry>
+	    <entry>X.Org development aclocal macros</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xorg-server</literal></entry>
+	    <entry>X.Org X server and related programs</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xorgproto</literal></entry>
+	    <entry>X.Org protocol headers</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xp</literal></entry>
+	    <entry>X print library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xpm</literal></entry>
+	    <entry>X Pixmap library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xprintapputil</literal></entry>
+	    <entry>The XprintAppUtil library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xprintutil</literal></entry>
+	    <entry>The XprintUtil library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xrandr</literal></entry>
+	    <entry>X Resize and Rotate extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xrender</literal></entry>
+	    <entry>X Render extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xres</literal></entry>
+	    <entry>X Resource usage library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xscrnsaver</literal></entry>
+	    <entry>The XScrnSaver library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xshmfence</literal></entry>
+	    <entry>Shared memory 'SyncFence' synchronization
+	      primitive</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xt</literal></entry>
+	    <entry>X Toolkit library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xtrans</literal></entry>
+	    <entry>Abstract network code for X</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xtrap</literal></entry>
+	    <entry>The XTrap library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xtst</literal></entry>
+	    <entry>X Test extension</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xv</literal></entry>
+	    <entry>X Video Extension library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xvmc</literal></entry>
+	    <entry>X Video Extension Motion Compensation
+	      library</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xxf86dga</literal></entry>
+	    <entry>X DGA Extension</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xxf86misc</literal></entry>
+	    <entry>X XF86-Misc Extension</entry>
+	  </row>
+
+	  <row>
+	    <entry><literal>xxf86vm</literal></entry>
+	    <entry>X Vidmode Extension</entry>
+	  </row>
+	</tbody>
+      </tgroup>
+    </table>
+  </sect1>
+
+  <sect1 xml:id="uses-xorg-cat">
+    <title><literal>xorg-cat</literal></title>
+
+    <para>Possible arguments: <literal>app</literal>, <literal>data</literal>,
+      <literal>doc</literal>, <literal>driver</literal>,
+      <literal>font</literal>, <literal>lib</literal>, <literal>proto</literal>,
+      <literal>util</literal>, <literal>xserver</literal> and (none) or one off
+      <literal>autotools</literal> (default), <literal>meson</literal></para>
+
+    <para>Provide support for building <application>Xorg</application>
+      components.  It takes care of setting up common dependencies and an
+      appropriate configuration environment needed.  This is intended only
+      for <application>Xorg</application> components.></para>
+
+    <para>The category has to match upstream categories.</para>
+
+    <para>The second argument is the build system to use.
+      <application>autotools</application> is the default, but
+      <application>meson</application> is also supported.</para>
+  </sect1>
+
   <sect1 xml:id="uses-zip">
     <title><literal>zip</literal></title>
 



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201908260947.x7Q9luaB043543>