Export and docs

r-lib · Nov 17, 2018 · 9add64c · 9add64c
1 parent f48d952
commit 9add64c
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 4 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -16,5 +16,6 @@ Encoding: UTF-8
 LazyData: true
 Imports: sys (>= 2.1)
 RoxygenNote: 6.1.1
+Roxygen: list(markdown = TRUE)
 Suggests: 
     testthat
diff --git a/R/askpass.R b/R/askpass.R
@@ -31,8 +31,6 @@ askpass_path <- function(){
                                package = 'askpass', mustWork = TRUE)
   } else if(is_macos()){
     system.file('mac-askpass', package = 'askpass', mustWork = TRUE)
-  } else {
-    stop("No custom password entry app for your platform")
   }
 }
 

diff --git a/R/ssh.R b/R/ssh.R
@@ -0,0 +1,9 @@
+#' SSH ASKPASS
+#'
+#' This returns the path to the native askpass executable which can be
+#' used by git or ssh-agent. On Windows and MacOS the package uses this
+#' to automatically set the `SSH_ASKPASS` and `GIT_ASKPASS` variables on
+#' load (if not already set). Users don't have worry about this.
+ssh_askpass <- function(){
+  askpass_path()
+}
diff --git a/man/askpass.Rd b/man/askpass.Rd
diff --git a/man/ssh_askpass.Rd b/man/ssh_askpass.Rd
diff --git a/tests/testthat/test-option.R b/tests/testthat/test-option.R
@@ -2,7 +2,7 @@ context("test-option")
 
 test_that("program exists", {
   if(is_windows() || is_macos()){
-    expect_true(file.exists(askpass_path()))
+    expect_true(file.exists(ssh_askpass()))
   }
 })