Merge branch 'main' into aheadbehind

Author: maelle

DESCRIPTION

@@ -34,4 +34,4 @@ Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 SystemRequirements: libgit2 (>= 1.0): libgit2-devel (rpm) or libgit2-dev (deb)
 Language: en-US
-Config/roxygen2/version: 8.0.0.9000
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -32,8 +32,10 @@ export(git_config_get)
 export(git_config_global)
 export(git_config_global_get)
 export(git_config_global_set)
+export(git_config_global_unset)
 export(git_config_local_get)
 export(git_config_set)
+export(git_config_unset)
 export(git_conflicts)
 export(git_diff)
 export(git_diff_patch)
@@ -128,6 +130,7 @@ useDynLib(gert,R_git_commit_log)
 useDynLib(gert,R_git_commit_stats)
 useDynLib(gert,R_git_config_list)
 useDynLib(gert,R_git_config_set)
+useDynLib(gert,R_git_config_unset)
 useDynLib(gert,R_git_conflict_list)
 useDynLib(gert,R_git_create_branch)
 useDynLib(gert,R_git_delete_branch)

NEWS.md

@@ -1,5 +1,6 @@
 # gert (development version)
 
+- Add `git_config_global_unset()` and `git_config_unset()` (@iofarm, #273)
 - Add `git_restore()` function (#259)
 - Add `git_config_get()`, `git_config_local_get()`, and `git_config_global_get()` to retrieve a single named config option, returning `NULL` if unset (#267).
 - `git_clone()` without a `path` argument now clones into a directory named after the

R/config.R

@@ -1,16 +1,16 @@
 #' Get or set Git configuration
 #'
 #' @description
-#' Get or set Git options, as `git config` does on the command line. **Global**
-#' settings affect all of a user's Git operations (`git config --global`),
-#' whereas **local** settings are scoped to a specific repository (`git config
-#' --local`). When both exist, local options always win.
+#' Get, set, or unset Git options, as `git config` does on the command line.
+#' **Global** settings affect all of a user's Git operations
+#' (`git config --global`), whereas **local** settings are scoped to a specific
+#' repository (`git config --local`). When both exist, local options always win.
 #'
 #' ```{r echo = FALSE, results = "asis"}
 #' dat <- data.frame(
-#'   local = c("`git_config()`", "`git_config_get()`", "`git_config_local_get()`", "`git_config_set()`"),
-#'   global = c("`git_config_global()`", "`git_config_get()`", "`git_config_global_get()`", "`git_config_global_set()`"),
-#'   row.names = c("get all", "get one (local+global)", "get one (local or global only)", "set")
+#'   local = c("`git_config()`", "`git_config_get()`", "`git_config_local_get()`", "`git_config_set()`", "`git_config_unset()`"),
+#'   global = c("`git_config_global()`", "`git_config_get()`", "`git_config_global_get()`", "`git_config_global_set()`", "`git_config_global_unset()`"),
+#'   row.names = c("get all", "get one (local+global)", "get one (local or global only)", "set", "unset")
 #' )
 #' knitr::kable(dat, col.names = paste0("**", colnames(dat), "**"))
 #' ```
@@ -28,6 +28,8 @@
 #' * `git_config_set()`, `git_config_global_set()`: The previous value(s) of
 #'   `name` in local or global config, respectively. If this option was
 #'   previously unset, returns `NULL`. Returns invisibly.
+#' * `git_config_unset()`, `git_config_global_unset()`: The previous value(s) of
+#'   `name` that were unset. Returns invisibly.
 #'
 #' @note All entries in the `name` column are automatically normalised to
 #'   lowercase (see
@@ -146,6 +148,21 @@ git_config_global_set <- function(name, value, add = FALSE) {
   }
 }
 
+#' @export
+#' @rdname git_config
+#' @useDynLib gert R_git_config_unset
+#' @param pattern optional regular expression, for matching values to unset in
+#' case of multiple values
+git_config_unset <- function(name, pattern = NULL, repo = '.'){
+  .Call(R_git_config_unset, git_open(repo), name, pattern)
+}
+
+#' @export
+#' @rdname git_config
+git_config_global_unset <- function(name, pattern = NULL){
+  .Call(R_git_config_unset, NULL, name, pattern)
+}
+
 #' Show libgit2 version and capabilities
 #'
 #' `libgit2_config()` reveals which version of libgit2 gert is using and which

R/roxygen2.R

@@ -4,27 +4,28 @@ git_links <- function() {
   base_url <- "https://libgit2.org/docs/reference/main/%s/index.html"
   dat <- as.data.frame(
     rbind(
-      c("branch",     sprintf(base_url, "branch")),
+      c("branch", sprintf(base_url, "branch")),
       c("cherrypick", sprintf(base_url, "cherrypick")),
-      c("checkout",   sprintf(base_url, "checkout")),
-      c("clone",      sprintf(base_url, "clone")),
-      c("commit",     sprintf(base_url, "commit")),
-      c("config",     sprintf(base_url, "config")),
-      c("diff",       sprintf(base_url, "diff")),
-      c("graph",      sprintf(base_url, "graph")),
-      c("ignore",     sprintf(base_url, "ignore")),
-      c("index",      sprintf(base_url, "index")),
-      c("merge",      sprintf(base_url, "merge")),
-      c("rebase",     sprintf(base_url, "rebase")),
-      c("remote",     sprintf(base_url, "remote")),
+      c("checkout", sprintf(base_url, "checkout")),
+      c("clone", sprintf(base_url, "clone")),
+      c("commit", sprintf(base_url, "commit")),
+      c("config", sprintf(base_url, "config")),
+      c("diff", sprintf(base_url, "diff")),
+      c("graph", sprintf(base_url, "graph")),
+      c("ignore", sprintf(base_url, "ignore")),
+      c("index", sprintf(base_url, "index")),
+      c("merge", sprintf(base_url, "merge")),
+      c("rebase", sprintf(base_url, "rebase")),
+      c("remote", sprintf(base_url, "remote")),
       c("repository", sprintf(base_url, "repository")),
-      c("reset",      sprintf(base_url, "reset")),
-      c("revert",     sprintf(base_url, "revert")),
-      c("signature",  sprintf(base_url, "signature")),
-      c("stash",      sprintf(base_url, "stash")),
-      c("status",     sprintf(base_url, "status")),
-      c("tag",        sprintf(base_url, "tag")),
-      c("worktree",   sprintf(base_url, "worktree"))
+      c("reset", sprintf(base_url, "reset")),
+      c("revert", sprintf(base_url, "revert")),
+      c("signature", sprintf(base_url, "signature")),
+      c("stash", sprintf(base_url, "stash")),
+      c("status", sprintf(base_url, "status")),
+      c("submodule", sprintf(base_url, "submodule")),
+      c("tag", sprintf(base_url, "tag")),
+      c("worktree", sprintf(base_url, "worktree"))
     ),
     stringsAsFactors = FALSE
   )

R/submodules.R

@@ -7,6 +7,7 @@
 #' @rdname git_submodule
 #' @inheritParams git_open
 #' @useDynLib gert R_git_submodule_list
+#' @git submodule
 git_submodule_list <- function(repo = '.') {
   repo <- git_open(repo)
   .Call(R_git_submodule_list, repo)

man/git_config.Rd

@@ -104,3 +104,21 @@ SEXP R_git_config_set(SEXP ptr, SEXP name, SEXP value, SEXP add){
   git_config_free(cfg);
   return R_NilValue;
 }
+
+SEXP R_git_config_unset(SEXP ptr, SEXP name, SEXP pattern){
+  git_config *cfg = NULL;
+  const char *cname = CHAR(STRING_ELT(name, 0));
+  if(Rf_isNull(ptr)) {
+    bail_if(git_config_open_default(&cfg), "git_config_open_default");
+  } else {
+    bail_if(git_repository_config(&cfg, get_git_repository(ptr)),"git_repository_config");
+  }
+  if(Rf_length(pattern)){
+    const char *cpattern = CHAR(STRING_ELT(pattern, 0));
+    bail_if(git_config_delete_multivar(cfg, cname, cpattern), "git_config_delete_multivar");
+  } else {
+    bail_if(git_config_delete_entry(cfg, cname), "git_config_delete_entry");
+  }
+  git_config_free(cfg);
+  return R_NilValue;
+}

man/git_submodule.Rd

@@ -31,6 +31,7 @@ extern SEXP R_git_commit_log(SEXP, SEXP, SEXP, SEXP, SEXP);
 extern SEXP R_git_commit_stats(SEXP, SEXP);
 extern SEXP R_git_config_list(SEXP);
 extern SEXP R_git_config_set(SEXP, SEXP, SEXP, SEXP);
+extern SEXP R_git_config_unset(SEXP, SEXP, SEXP);
 extern SEXP R_git_conflict_list(SEXP);
 extern SEXP R_git_create_branch(SEXP, SEXP, SEXP, SEXP, SEXP);
 extern SEXP R_git_delete_branch(SEXP, SEXP);
@@ -116,6 +117,7 @@ static const R_CallMethodDef CallEntries[] = {
   {"R_git_commit_stats",        (DL_FUNC) &R_git_commit_stats,        2},
   {"R_git_config_list",         (DL_FUNC) &R_git_config_list,         1},
   {"R_git_config_set",          (DL_FUNC) &R_git_config_set,          4},
+  {"R_git_config_unset",        (DL_FUNC) &R_git_config_unset,        3},
   {"R_git_conflict_list",       (DL_FUNC) &R_git_conflict_list,       1},
   {"R_git_create_branch",       (DL_FUNC) &R_git_create_branch,       5},
   {"R_git_delete_branch",       (DL_FUNC) &R_git_delete_branch,       2},