CVS commit: pkgsrc/doc/guide/files

["Brook Milligan" <brook%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   brook
Date:           Wed Aug 14 17:26:31 UTC 2019

Modified Files:
        pkgsrc/doc/guide/files: creating.xml

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


To generate a diff of this commit:
cvs rdiff -u -r1.28 -r1.29 pkgsrc/doc/guide/files/creating.xml

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/doc/guide/files/creating.xml
diff -u pkgsrc/doc/guide/files/creating.xml:1.28 pkgsrc/doc/guide/files/creating.xml:1.29
--- pkgsrc/doc/guide/files/creating.xml:1.28    Mon May 20 18:14:24 2019
+++ pkgsrc/doc/guide/files/creating.xml Wed Aug 14 17:26:31 2019
@@ -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 @@ Look inside <filename>versioned_dependen
 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">