Attempt workaround of CRAN Windows hang on update.dev.pkg.Rd example (#5421)

Author: jangorecki

.appveyor.yml

@@ -16,8 +16,9 @@ environment:
   global:
     CRAN: http://cloud.r-project.org
     WARNINGS_ARE_ERRORS: 1
-    R_CHECK_ARGS: --no-manual
-# R_CHECK_ARGS specified in order to turn off --as-cran (on by default) as that can be slow
+    R_CHECK_ARGS: --as-cran --no-manual
+# --no-manual to avoid error 'pdflatex is not available'
+# --as-cran no longer a lot slower (now takes under 6 mins with and without); logs show _R_CHECK_CRAN_INCOMING_=FALSE which could take 5+ mins
     _R_CHECK_NO_STOP_ON_TEST_ERROR_: true
 # continue tests even if some script failed
     _R_CHECK_TESTS_NLINES_: 0

NAMESPACE

@@ -131,8 +131,7 @@ S3method(melt, default)
 export(melt.data.table, dcast.data.table)
 
 import(utils)
-S3method(update, dev.pkg)
-export(update.dev.pkg)
+export(update_dev_pkg)
 S3method(tail, data.table)
 S3method(head, data.table)
 import(stats)

NEWS.md

@@ -605,6 +605,8 @@
 
 16. The options `datatable.print.class` and `datatable.print.keys` are now `TRUE` by default. They have been available since v1.9.8 (Nov 2016) and v1.11.0 (May 2018) respectively.
 
+17. `update.dev.pkg()` has been renamed `update_dev_pkg()` to get out of the way of the `stats::update` generic function, [#5421](https://github.com/Rdatatable/data.table/pull/5421). This is a utility function which upgrades the version of `data.table` to the latest commit in development which has also passed all tests. As such we don't expect any backwards compatibility concerns.
+
 
 # data.table [v1.14.2](https://github.com/Rdatatable/data.table/milestone/24?closed=1)  (27 Sep 2021)
 

R/devel.R

@@ -17,7 +17,7 @@ dcf.repo = function(pkg, repo, field, type) {
   dcf[dcf[,"Package"]==pkg, field][[1L]]
 }
 
-update.dev.pkg = function(object="data.table", repo="https://Rdatatable.gitlab.io/data.table", field="Revision", type=getOption("pkgType"), lib=NULL, ...) {
+update_dev_pkg = function(object="data.table", repo="https://Rdatatable.gitlab.io/data.table", field="Revision", type=getOption("pkgType"), lib=NULL, ...) {
   # this works for any package, not just data.table
   pkg = object
   # perform package upgrade when new Revision present
@@ -32,7 +32,7 @@ update.dev.pkg = function(object="data.table", repo="https://Rdatatable.gitlab.i
          pkg, field, contrib.url(repo, type=type))
   # see if Revision is different then currently installed Revision, note that installed package will have Revision info only when it was installed from remote devel repo
   upg = una || !identical(ups, dcf.lib(pkg, field, lib.loc=lib))
-  # update.dev.pkg fails on windows R 4.0.0, we have to unload package namespace before installing new version #4403
+  # update_dev_pkg fails on windows R 4.0.0, we have to unload package namespace before installing new version #4403
   on.exit({
     if (upg) {
       unloadNamespace(pkg) ## hopefully will release dll lock on Windows

R/onAttach.R

@@ -27,7 +27,7 @@
     if (gettext("TRANSLATION CHECK") != "TRANSLATION CHECK")
       packageStartupMessagef("**********\nRunning data.table in English; package support is available in English only. When searching for online help, be sure to also check for the English error message. This can be obtained by looking at the po/R-<locale>.po and po/<locale>.po files in the package source, where the native language and English error messages can be found side-by-side\n**********")
     if (dev && (Sys.Date() - as.Date(d))>28L)
-      packageStartupMessagef("**********\nThis development version of data.table was built more than 4 weeks ago. Please update: data.table::update.dev.pkg()\n**********")
+      packageStartupMessagef("**********\nThis development version of data.table was built more than 4 weeks ago. Please update: data.table::update_dev_pkg()\n**********")
     if (!.Call(ChasOpenMP)) {
       packageStartupMessagef("**********\nThis installation of data.table has not detected OpenMP support. It should still work but in single-threaded mode.\n", appendLF=FALSE)
       if (Sys.info()["sysname"] == "Darwin")

README.md

@@ -42,8 +42,8 @@
 ```r
 install.packages("data.table")
 
-# latest development version:
-data.table::update.dev.pkg()
+# latest development version that has passed all tests:
+data.table::update_dev_pkg()
 ```
 
 See [the Installation wiki](https://github.com/Rdatatable/data.table/wiki/Installation) for more details.

man/data.table.Rd

@@ -453,8 +453,8 @@ if (interactive()) {
   # keep up to date with latest stable version on CRAN
   update.packages()
 
-  # get the latest devel version
-  update.dev.pkg()
+  # get the latest devel version that has passed all tests
+  update_dev_pkg()
   # read more at:
   # https://github.com/Rdatatable/data.table/wiki/Installation
 }

man/update.dev.pkg.Rd man/update_dev_pkg.Rdman/update.dev.pkg.Rd renamed to man/update_dev_pkg.Rd

@@ -1,11 +1,10 @@
-\name{update.dev.pkg}
-\alias{update}
-\alias{update.dev.pkg}
+\name{update_dev_pkg}
+\alias{update_dev_pkg}
 \title{Perform update of development version of a package}
 \description{
-  It will download and install package from devel repository only when new commit is available there, otherwise only PACKAGES file is transferred. Defaults are set to update \code{data.table}, other packages can be used as well. Their repository has to include git commit information in PACKAGES file.
+  Downloads and installs latest development version only when a new commit is available which has also passed all tests. Defaults are set to update \code{data.table}, other packages can be used as well. Their repository has to include git commit information in PACKAGES file.
 }
-\usage{\method{update}{dev.pkg}(object="data.table",
+\usage{update_dev_pkg(object="data.table",
        repo="https://Rdatatable.gitlab.io/data.table",
        field="Revision", type=getOption("pkgType"), lib=NULL, \dots)
 }
@@ -30,7 +29,8 @@
   NULL.
 }
 \examples{
-  # data.table::update.dev.pkg()
+\dontshow{ # using if(FALSE) because \dontrun could still be run by  --run-dontrun; #5421 }
+  if (FALSE) data.table::update_dev_pkg()
 }
 \seealso{
   \code{\link{data.table}}

po/R-data.table.pot

@@ -1567,7 +1567,7 @@ msgstr ""
 msgid "**********\nRunning data.table in English; package support is available in English only. When searching for online help, be sure to also check for the English error message. This can be obtained by looking at the po/R-<locale>.po and po/<locale>.po files in the package source, where the native language and English error messages can be found side-by-side\n**********"
 msgstr ""
 
-msgid "**********\nThis development version of data.table was built more than 4 weeks ago. Please update: data.table::update.dev.pkg()\n**********"
+msgid "**********\nThis development version of data.table was built more than 4 weeks ago. Please update: data.table::update_dev_pkg()\n**********"
 msgstr ""
 
 msgid "**********"

po/R-zh_CN.po

@@ -2161,11 +2161,11 @@ msgstr ""
 msgid ""
 "**********\n"
 "This development version of data.table was built more than 4 weeks ago. "
-"Please update: data.table::update.dev.pkg()\n"
+"Please update: data.table::update_dev_pkg()\n"
 "**********"
 msgstr ""
 "**********这个data.table的开发版本是在4个多星期之前构建的。请更新版本：data."
-"table::update.dev.pkg()\n"
+"table::update_dev_pkg()\n"
 "**********"
 
 msgid "**********"