File: lookup_commit.Rd

package info (click to toggle)
r-cran-git2r 0.31.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,288 kB
  • sloc: ansic: 8,283; sh: 4,116; makefile: 4
file content (56 lines) | stat: -rw-r--r-- 1,378 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/repository.R
\name{lookup_commit}
\alias{lookup_commit}
\alias{lookup_commit.git_branch}
\alias{lookup_commit.git_commit}
\alias{lookup_commit.git_tag}
\alias{lookup_commit.git_reference}
\title{Lookup the commit related to a git object}
\usage{
lookup_commit(object)

\method{lookup_commit}{git_branch}(object)

\method{lookup_commit}{git_commit}(object)

\method{lookup_commit}{git_tag}(object)

\method{lookup_commit}{git_reference}(object)
}
\arguments{
\item{object}{a git object to get the related commit from.}
}
\value{
A git commit object.
}
\description{
Lookup the commit related to a git_reference, git_tag or
git_branch object.
}
\examples{
\dontrun{
## Create a directory in tempdir
path <- tempfile(pattern="git2r-")
dir.create(path)

## Initialize a repository
repo <- init(path)
config(repo, user.name = "Alice", user.email = "alice@example.org")

## Create a file, add and commit
lines <- "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do"
writeLines(lines, con = file.path(path, "test.txt"))
add(repo, "test.txt")
commit(repo, "Commit message 1")

## Get the commit pointed to by the 'master' branch
lookup_commit(repository_head(repo))

## Create a tag
a_tag <- tag(repo, "Tagname", "Tag message")

## Get the commit pointed to by 'a_tag'
lookup_commit(a_tag)
}
}