[pkgsrc/trunk]: pkgsrc/doc/guide/files Add a section to "Common packages" des...

[brook <brook%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/97c74ae47ffc
branches:  trunk
changeset: 399713:97c74ae47ffc
user:      brook <brook%pkgsrc.org@localhost>
date:      Wed Aug 14 17:26:31 2019 +0000

description:
Add a section to "Common packages" describing a typical R package.

diffstat:

 doc/guide/files/creating.xml |  21 ++++++++++++++++++++-
 1 files changed, 20 insertions(+), 1 deletions(-)

diffs (35 lines):

diff -r 350c866bd5a4 -r 97c74ae47ffc doc/guide/files/creating.xml
--- a/doc/guide/files/creating.xml      Wed Aug 14 17:22:36 2019 +0000
+++ b/doc/guide/files/creating.xml      Wed Aug 14 17:26:31 2019 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: creating.xml,v 1.28 2019/05/20 18:14:24 leot Exp $ -->
+<!-- $NetBSD: creating.xml,v 1.29 2019/08/14 17:26:31 brook Exp $ -->
 
 <chapter id="creating">
 <title>Creating a new pkgsrc package from scratch</title>
@@ -195,6 +195,25 @@
 of supported packages.</para>
 </sect2>
 
+<sect2 id="creating.R-package">
+<title>R packages</title>
+
+<para>Simple R packages from <ulink
+url="https://cran.r-project.org/web/packages/available_packages_by_name.html";>CRAN</ulink>
+are handled automatically by <command>R2pkg</command>, which is
+available in <filename role="pkg">pkgtools/R2pkg</filename>.
+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
+<filename>DESCRIPTION</filename> file as part of each R package on
+<ulink
+url="https://cran.r-project.org/web/packages/available_packages_by_name.html";>CRAN</ulink>.
+Consequently, <command>R2pkg</command> downloads that information and
+creates or updates a package in the canonical form.  The resulting
+package should be reviewed for correctness.</para>
+
+</sect2>
+
 </sect1>
 
 <sect1 id="creating.examples">