Fri May 10 12:31:21 2024 UTC (16d)
doc/pkgsrc.*: regen


(wiz)
diff -r1.371 -r1.372 pkgsrc/doc/pkgsrc.html
diff -r1.369 -r1.370 pkgsrc/doc/pkgsrc.txt

cvs diff -r1.371 -r1.372 pkgsrc/doc/pkgsrc.html (expand / switch to unified diff)

--- pkgsrc/doc/pkgsrc.html 2024/05/08 10:44:37 1.371
+++ pkgsrc/doc/pkgsrc.html 2024/05/10 12:31:21 1.372
@@ -5343,70 +5343,57 @@ left to do.

 @@ -5343,70 +5343,57 @@ left to do.

5343<a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div> 5343<a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
5344<p>Python modules and programs packages are easily created using a 5344<p>Python modules and programs packages are easily created using a
5345set of predefined variables.</p> 5345set of predefined variables.</p>
5346<p> 5346<p>
5347If some Python versions are not supported by the software, set the 5347If some Python versions are not supported by the software, set the
5348<code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions 5348<code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5349that are not supported, e.g. 5349that are not supported, e.g.
5350</p> 5350</p>
5351<pre class="programlisting"> 5351<pre class="programlisting">
5352PYTHON_VERSIONS_INCOMPATIBLE= 27 5352PYTHON_VERSIONS_INCOMPATIBLE= 27
5353</pre> 5353</pre>
5354<p> 5354<p>
5355If the packaged software is a Python module, include 5355If the packaged software is a Python module, include
5356<code class="filename">../../lang/python/wheel.mk</code>. 5356<code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
5357Note per PEP-518, the minimum and default requirements to create .whl files 5357the minimum and default requirements to create .whl files are
5358are py-setuptools plus py-wheel; however, there are various other possible 5358<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a> plus <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-wheel/index.html" target="_top"><code class="filename">devel/py-wheel</code></a>; however, there are various other
5359tools that projects can use. Thus inclusion of <code class="filename">wheel.mk</code> 5359possible tools that projects can use. Thus inclusion of
5360does not imply these defaults are defined as TOOL_DEPENDS. Whatever the project 5360<code class="filename">wheel.mk</code> does not imply these defaults are
5361specifically requires as packaging tools must be defined in the package Makefile. 5361defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
 5362specifically requires as packaging tools must be defined in the
 5363package Makefile.
5362</p> 5364</p>
5363<p>The package directory should be called 5365<p>The package directory should be called
5364<span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to 5366<span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
5365<span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g. 5367<span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
5366</p> 5368</p>
5367<pre class="programlisting"> 5369<pre class="programlisting">
5368DISTNAME= foopymodule-1.2.10 5370DISTNAME= foopymodule-1.2.10
5369PKGNAME= ${PYPKGPREFIX}-${DISTNAME} 5371PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5370</pre> 5372</pre>
5371<p> 5373<p>
5372For software in PyPi, the name should match what PyPi specifies for 5374For software in PyPi, the name should match what PyPi specifies for
5373"pip install software". 5375"pip install software".
5374</p> 5376</p>
5375<p>If it is an application, include 5377<p>If it is an application, include
5376<span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>. 5378<span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
5377In order to correctly set the path to the Python interpreter, use the 5379In order to correctly set the path to the Python interpreter, use the
5378<code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files 5380<code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5379(paths relative to <code class="varname">WRKSRC</code>) that must be corrected. 5381(paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5380For example: 5382For example:
5381</p> 5383</p>
5382<pre class="programlisting"> 5384<pre class="programlisting">
5383REPLACE_PYTHON= *.py 5385REPLACE_PYTHON= *.py
5384</pre> 5386</pre>
5385<p>Some Python modules have separate distributions for Python-2.x 
5386and Python-3.x support. In pkgsrc this is handled by the 
5387<code class="filename">versioned_dependencies.mk</code> file. Set 
5388<code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of 
5389packages that should be depended upon and include 
5390<span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>, 
5391then the pkgsrc infrastructure will depend on the appropriate package 
5392version. For example: 
5393</p> 
5394<pre class="programlisting"> 
5395PYTHON_VERSIONED_DEPENDENCIES=dialog 
5396</pre> 
5397<p> 
5398Look inside <code class="filename">versioned_dependencies.mk</code> for a list 
5399of supported packages.</p> 
5400</div> 5387</div>
5401<div class="sect2"> 5388<div class="sect2">
5402<div class="titlepage"><div><div><h3 class="title"> 5389<div class="titlepage"><div><div><h3 class="title">
5403<a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div> 5390<a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
5404<p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a> 5391<p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>
5405are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is 5392are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
5406available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>. 5393available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
5407Individual packages (and optionally their dependencies) may be created 5394Individual packages (and optionally their dependencies) may be created
5408and updated. R packages generally follow the same form, and most of 5395and updated. R packages generally follow the same form, and most of
5409the relevant information needed is contained in a 5396the relevant information needed is contained in a
5410<code class="filename">DESCRIPTION</code> file as part of each R package on 5397<code class="filename">DESCRIPTION</code> file as part of each R package on
5411<a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>. 5398<a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5412Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and 5399Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and

cvs diff -r1.369 -r1.370 pkgsrc/doc/pkgsrc.txt (expand / switch to unified diff)

--- pkgsrc/doc/pkgsrc.txt 2024/05/08 10:44:37 1.369
+++ pkgsrc/doc/pkgsrc.txt 2024/05/10 12:31:21 1.370
@@ -4215,57 +4215,48 @@ package involves only a few steps. @@ -4215,57 +4215,48 @@ package involves only a few steps.
421514.1.1. Python modules and programs 421514.1.1. Python modules and programs
4216 4216
4217Python modules and programs packages are easily created using a set of 4217Python modules and programs packages are easily created using a set of
4218predefined variables. 4218predefined variables.
4219 4219
4220If some Python versions are not supported by the software, set the 4220If some Python versions are not supported by the software, set the
4221PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not 4221PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4222supported, e.g. 4222supported, e.g.
4223 4223
4224PYTHON_VERSIONS_INCOMPATIBLE= 27 4224PYTHON_VERSIONS_INCOMPATIBLE= 27
4225 4225
4226If the packaged software is a Python module, include ../../lang/python/ 4226If the packaged software is a Python module, include ../../lang/python/
4227wheel.mk. Note per PEP-518, the minimum and default requirements to create .whl 4227wheel.mk. Note per PEP-518, the minimum and default requirements to create .whl
4228files are py-setuptools plus py-wheel; however, there are various other 4228files are devel/py-setuptools plus devel/py-wheel; however, there are various
4229possible tools that projects can use. Thus inclusion of wheel.mk does not imply 4229other possible tools that projects can use. Thus inclusion of wheel.mk does not
4230these defaults are defined as TOOL_DEPENDS. Whatever the project specifically 4230imply these defaults are defined as TOOL_DEPENDS. Whatever the project
4231requires as packaging tools must be defined in the package Makefile. 4231specifically requires as packaging tools must be defined in the package
 4232Makefile.
4232 4233
4233The package directory should be called "py-software" and PKGNAME should be set 4234The package directory should be called "py-software" and PKGNAME should be set
4234to "${PYPKGPREFIX}-${DISTNAME}", e.g. 4235to "${PYPKGPREFIX}-${DISTNAME}", e.g.
4235 4236
4236DISTNAME= foopymodule-1.2.10 4237DISTNAME= foopymodule-1.2.10
4237PKGNAME= ${PYPKGPREFIX}-${DISTNAME} 4238PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
4238 4239
4239For software in PyPi, the name should match what PyPi specifies for "pip 4240For software in PyPi, the name should match what PyPi specifies for "pip
4240install software". 4241install software".
4241 4242
4242If it is an application, include "../../lang/python/application.mk". In order 4243If it is an application, include "../../lang/python/application.mk". In order
4243to correctly set the path to the Python interpreter, use the REPLACE_PYTHON 4244to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4244variable and set it to the list of files (paths relative to WRKSRC) that must 4245variable and set it to the list of files (paths relative to WRKSRC) that must
4245be corrected. For example: 4246be corrected. For example:
4246 4247
4247REPLACE_PYTHON= *.py 4248REPLACE_PYTHON= *.py
4248 4249
4249Some Python modules have separate distributions for Python-2.x and Python-3.x 
4250support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set 
4251PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended 
4252upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc 
4253infrastructure will depend on the appropriate package version. For example: 
4254 
4255PYTHON_VERSIONED_DEPENDENCIES=dialog 
4256 
4257Look inside versioned_dependencies.mk for a list of supported packages. 
4258 
425914.1.2. R packages 425014.1.2. R packages
4260 4251
4261Simple R packages from CRAN are handled automatically by R2pkg, which is 4252Simple R packages from CRAN are handled automatically by R2pkg, which is
4262available in pkgtools/R2pkg. Individual packages (and optionally their 4253available in pkgtools/R2pkg. Individual packages (and optionally their
4263dependencies) may be created and updated. R packages generally follow the same 4254dependencies) may be created and updated. R packages generally follow the same
4264form, and most of the relevant information needed is contained in a DESCRIPTION 4255form, and most of the relevant information needed is contained in a DESCRIPTION
4265file as part of each R package on CRAN. Consequently, R2pkg downloads that 4256file as part of each R package on CRAN. Consequently, R2pkg downloads that
4266information and creates or updates a package in the canonical form. The 4257information and creates or updates a package in the canonical form. The
4267resulting package should be reviewed for correctness. 4258resulting package should be reviewed for correctness.
4268 4259
426914.1.3. TeXlive packages 426014.1.3. TeXlive packages
4270 4261
4271TeXlive packages from CTAN are handled automatically by texlive2pkg, which is 4262TeXlive packages from CTAN are handled automatically by texlive2pkg, which is