git2r (version 0.21.0)

rm_file: Remove files from the working tree and from the index

Description

Remove files from the working tree and from the index

Usage

rm_file(repo, path)
# S4 method for git_repository,character
rm_file(repo, path)

Arguments

repo

The repository object.

path

character vector with filenames to remove. The path must be relative to the repository's working folder. Only files known to Git are removed.

Value

invisible(NULL)

Examples

# NOT RUN {
## Initialize a repository
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)

## Create a user
config(repo, user.name="Alice", user.email="[e-mail]")

## Create a file
writeLines("Hello world!", file.path(path, "file-to-remove.txt"))

## Add file to repository
add(repo, "file-to-remove.txt")
commit(repo, "First commit message")

## Remove file
rm_file(repo, "file-to-remove.txt")

## View status of repository
status(repo)
# }
# NOT RUN {
# }