File: git_config_files.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 (41 lines) | stat: -rw-r--r-- 1,217 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/config.R
\name{git_config_files}
\alias{git_config_files}
\title{Locate the path to configuration files}
\usage{
git_config_files(repo = ".")
}
\arguments{
\item{repo}{a path to a repository or a \code{git_repository}
object. Default is '.'}
}
\value{
a \code{data.frame} with one row per potential
    configuration file where \code{NA} means not found.
}
\description{
Potential configuration files:
\describe{
  \item{system}{
    Locate the path to the system configuration file. If
    '/etc/gitconfig' doesn't exist, it will look for
    '\%PROGRAMFILES\%'.
  }
  \item{xdg}{
    Locate the path to the global xdg compatible configuration
    file. The xdg compatible configuration file is usually located
    in '$HOME/.config/git/config'. This method will try to guess
    the full path to that file, if the file exists.
  }
  \item{global}{
    The user or global configuration file is usually located in
    '$HOME/.gitconfig'. This method will try to guess the full
    path to that file, if the file exists.
  }
  \item{local}{
    Locate the path to the repository specific configuration file,
    if the file exists.
  }
}
}