Better error message when build tools are not found

Fixes #68
r-lib · Aug 5, 2019 · e043ff2 · e043ff2
1 parent 7b3f142
commit e043ff2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,8 @@
-
 # dev
 
+* `check_build_tools()` now has a more helpful error message which points you
+  towards ways to debug the issue (#68).
+
 * `pkgbuild_process` now do not set custom compiler flags, and it uses
   the user's `Makevars` file (@gaborcsardi, #76).
 

diff --git a/R/build-tools.R b/R/build-tools.R
@@ -38,7 +38,9 @@ has_build_tools <- function(debug = FALSE) {
 #' @rdname has_build_tools
 check_build_tools <- function(debug = FALSE) {
   if (!has_build_tools(debug = debug))
-    stop("Could not find tools necessary to compile a package", call. = FALSE)
+    stop(
+      "Could not find tools necessary to compile a package\n",
+      "Call `pkgbuild::check_build_tools(debug = TRUE)` to diagnose the problem.", call. = FALSE)
 
   invisible(TRUE)
 }