pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc doc/pkgsrc.*: regen
details: https://anonhg.NetBSD.org/pkgsrc/rev/3db96402cd89
branches: trunk
changeset: 338463:3db96402cd89
user: brook <brook%pkgsrc.org@localhost>
date: Sun Aug 25 17:21:29 2019 +0000
description:
doc/pkgsrc.*: regen
diffstat:
doc/pkgsrc.html | 77 +++++++++++++++++++++++++++++++++++++++++++++++++-------
doc/pkgsrc.txt | 46 ++++++++++++++++++++++++++++++++++
2 files changed, 113 insertions(+), 10 deletions(-)
diffs (255 lines):
diff -r 6476cb5f16f9 -r 3db96402cd89 doc/pkgsrc.html
--- a/doc/pkgsrc.html Sun Aug 25 17:11:00 2019 +0000
+++ b/doc/pkgsrc.html Sun Aug 25 17:21:29 2019 +0000
@@ -163,6 +163,8 @@
<dd><dl>
<dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
<dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -2797,6 +2799,8 @@
<dd><dl>
<dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
<dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -3058,6 +3062,8 @@
<dd><dl>
<dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
<dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -3229,6 +3235,57 @@
Look inside <code class="filename">versioned_dependencies.mk</code> for a list
of supported packages.</p>
</div>
+<div class="sect2">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
+<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>
+are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
+available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html"; target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
+Individual packages (and optionally their dependencies) may be created
+and updated. R packages generally follow the same form, and most of
+the relevant information needed is contained in a
+<code class="filename">DESCRIPTION</code> file as part of each R package on
+<a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html"; target="_top">CRAN</a>.
+Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
+creates or updates a package in the canonical form. The resulting
+package should be reviewed for correctness.</p>
+</div>
+<div class="sect2">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
+<p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/"; target="_top">CTAN</a> are handled automatically by
+<span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html"; target="_top"><code
class="filename">pkgtools/texlive2pkg</code></a>.</p>
+<p>If the TeXlive package name is not known, it may be useful to
+search <a class="ulink" href="https://www.ctan.org/"; target="_top">CTAN</a>. A
+<span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
+identifies the basename of the package file in the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive"; target="_top">TeXlive
+archive</a>.</p>
+<p>If the TeXlive package name is known, download the files from
+the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive"; target="_top">TeXlive
+archive</a>. For package <code class="filename">foo</code>, you will need
+to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
+also have associated documentation packages, so download
+<code class="filename">foo.doc.tar.xz</code> at the same time. These files
+should be placed in the appropriate category directory, which is often
+but not always <code class="filename">print</code>. Then run the following
+command in the category directory.</p>
+<pre class="programlisting">
+texlive2pkg foo.tar.xz foo.doc.tar.xz
+</pre>
+<p>This will create two packages, <code class="filename">tex-foo</code> and
+<code class="filename">tex-foo-doc</code>. Be sure to check that both packages
+are correct.</p>
+<p>Finally, <a class="ulink" href="https://www.ctan.org/"; target="_top">CTAN</a>
+currently does not include version information in package filenames
+and changes their contents periodically when updates occur.
+Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/"; target="_top">CTAN</a> and instead relies on the
+pkgsrc archives. For each new or updated TeXlive package, e.g., the
+main one and the corresponding documentation, upload the distfiles
+with the following command in each package directory.</p>
+<pre class="programlisting">
+make upload-distfiles
+</pre>
+</div>
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -8942,7 +8999,7 @@
and if you still don't have the answer, ask on the
<code class="literal">pkgsrc-users</code> mailing list.</p>
<div class="qandaset">
-<a name="idm78996464"></a><dl>
+<a name="idp140546527059992"></a><dl>
<dt>24.1. <a href="#devfaq.makeflags">What is the difference between
MAKEFLAGS, .MAKEFLAGS and
MAKE_FLAGS?</a>
@@ -8987,7 +9044,7 @@
<tbody>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.makeflags"></a><a name="idm78996080"></a><p><b>24.1.</b></p>
+<a name="devfaq.makeflags"></a><a name="idp140546527060648"></a><p><b>24.1.</b></p>
</td>
<td align="left" valign="top"><p>What is the difference between
<code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
@@ -9003,7 +9060,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.make"></a><a name="idm78992112"></a><p><b>24.2.</b></p>
+<a name="devfaq.make"></a><a name="idp140546527065064"></a><p><b>24.2.</b></p>
</td>
<td align="left" valign="top"><p>What is the difference between
<code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
@@ -9021,7 +9078,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.cc"></a><a name="idm78987632"></a><p><b>24.3.</b></p>
+<a name="devfaq.cc"></a><a name="idp140546527070072"></a><p><b>24.3.</b></p>
</td>
<td align="left" valign="top"><p>What is the difference between
<code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
@@ -9039,7 +9096,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.bl3flags"></a><a name="idm78983536"></a><p><b>24.4.</b></p>
+<a name="devfaq.bl3flags"></a><a name="idp140546527074984"></a><p><b>24.4.</b></p>
</td>
<td align="left" valign="top"><p>What is the difference between
<code class="varname">BUILDLINK_LDFLAGS</code>,
@@ -9052,7 +9109,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.bl3prefix"></a><a name="idm78981360"></a><p><b>24.5.</b></p>
+<a name="devfaq.bl3prefix"></a><a name="idp140546527077576"></a><p><b>24.5.</b></p>
</td>
<td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
@@ -9068,7 +9125,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.master_sites"></a><a name="idm78978160"></a><p><b>24.6.</b></p>
+<a name="devfaq.master_sites"></a><a name="idp140546527081464"></a><p><b>24.6.</b></p>
</td>
<td align="left" valign="top"><p>What does
<code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
@@ -9092,7 +9149,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.mailinglists"></a><a name="idm78971248"></a><p><b>24.7.</b></p>
+<a name="devfaq.mailinglists"></a><a name="idp140546527089128"></a><p><b>24.7.</b></p>
</td>
<td align="left" valign="top"><p>Which mailing lists are there for package
developers?</p></td>
@@ -9117,7 +9174,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.documentation"></a><a name="idm78967536"></a><p><b>24.8.</b></p>
+<a name="devfaq.documentation"></a><a name="idp140546527094088"></a><p><b>24.8.</b></p>
</td>
<td align="left" valign="top"><p>Where is the pkgsrc
documentation?</p></td>
@@ -9165,7 +9222,7 @@
</tr>
<tr class="question">
<td align="left" valign="top">
-<a name="devfaq.too-much-time"></a><a name="idm78961008"></a><p><b>24.9.</b></p>
+<a name="devfaq.too-much-time"></a><a name="idp140546527102888"></a><p><b>24.9.</b></p>
</td>
<td align="left" valign="top"><p>I have a little time to kill. What shall I
do?</p></td>
diff -r 6476cb5f16f9 -r 3db96402cd89 doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Sun Aug 25 17:11:00 2019 +0000
+++ b/doc/pkgsrc.txt Sun Aug 25 17:21:29 2019 +0000
@@ -147,6 +147,8 @@
12.1.1. Perl modules
12.1.2. Python modules and programs
+ 12.1.3. R packages
+ 12.1.4. TeXlive packages
12.2. Examples
@@ -2372,6 +2374,8 @@
12.1.1. Perl modules
12.1.2. Python modules and programs
+ 12.1.3. R packages
+ 12.1.4. TeXlive packages
12.2. Examples
@@ -2620,6 +2624,8 @@
12.1.1. Perl modules
12.1.2. Python modules and programs
+ 12.1.3. R packages
+ 12.1.4. TeXlive packages
12.2. Examples
@@ -2760,6 +2766,46 @@
Look inside versioned_dependencies.mk for a list of supported packages.
+12.1.3. R packages
+
+Simple R packages from CRAN are handled automatically by R2pkg, which is
+available in pkgtools/R2pkg. Individual packages (and optionally their
+dependencies) may be created and updated. R packages generally follow the same
+form, and most of the relevant information needed is contained in a DESCRIPTION
+file as part of each R package on CRAN. Consequently, R2pkg downloads that
+information and creates or updates a package in the canonical form. The
+resulting package should be reviewed for correctness.
+
+12.1.4. TeXlive packages
+
+TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
+available in pkgtools/texlive2pkg.
+
+If the TeXlive package name is not known, it may be useful to search CTAN. A "
+Contained in" field on the package page typically identifies the basename of
+the package file in the TeXlive archive.
+
+If the TeXlive package name is known, download the files from the TeXlive
+archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
+packages also have associated documentation packages, so download
+foo.doc.tar.xz at the same time. These files should be placed in the
+appropriate category directory, which is often but not always print. Then run
+the following command in the category directory.
+
+texlive2pkg foo.tar.xz foo.doc.tar.xz
+
+This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
+both packages are correct.
+
+Finally, CTAN currently does not include version information in package
+filenames and changes their contents periodically when updates occur.
+Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
+instead relies on the pkgsrc archives. For each new or updated TeXlive package,
+e.g., the main one and the corresponding documentation, upload the distfiles
+with the following command in each package directory.
+
+make upload-distfiles
+
12.2. Examples
12.2.1. How the www/nvu package came into pkgsrc
Home |
Main Index |
Thread Index |
Old Index