mirror of
https://github.com/git/git.git
synced 2025-12-12 20:36:24 +01:00
Merge branch 'lo/repo-info'
A new subcommand "git repo" gives users a way to grab various repository characteristics. * lo/repo-info: repo: add the --format flag repo: add the field layout.shallow repo: add the field layout.bare repo: add the field references.format repo: declare the repo command
This commit is contained in:
84
Documentation/git-repo.adoc
Normal file
84
Documentation/git-repo.adoc
Normal file
@@ -0,0 +1,84 @@
|
||||
git-repo(1)
|
||||
===========
|
||||
|
||||
NAME
|
||||
----
|
||||
git-repo - Retrieve information about the repository
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
[synopsis]
|
||||
git repo info [--format=(keyvalue|nul)] [<key>...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Retrieve information about the repository.
|
||||
|
||||
THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
|
||||
|
||||
COMMANDS
|
||||
--------
|
||||
`info [--format=(keyvalue|nul)] [<key>...]`::
|
||||
Retrieve metadata-related information about the current repository. Only
|
||||
the requested data will be returned based on their keys (see "INFO KEYS"
|
||||
section below).
|
||||
+
|
||||
The values are returned in the same order in which their respective keys were
|
||||
requested.
|
||||
+
|
||||
The output format can be chosen through the flag `--format`. Two formats are
|
||||
supported:
|
||||
+
|
||||
`keyvalue`:::
|
||||
output key-value pairs one per line using the `=` character as
|
||||
the delimiter between the key and the value. Values containing "unusual"
|
||||
characters are quoted as explained for the configuration variable
|
||||
`core.quotePath` (see linkgit:git-config[1]). This is the default.
|
||||
|
||||
`nul`:::
|
||||
similar to `keyvalue`, but using a newline character as the delimiter
|
||||
between the key and the value and using a NUL character after each value.
|
||||
This format is better suited for being parsed by another applications than
|
||||
`keyvalue`. Unlike in the `keyvalue` format, the values are never quoted.
|
||||
|
||||
INFO KEYS
|
||||
---------
|
||||
In order to obtain a set of values from `git repo info`, you should provide
|
||||
the keys that identify them. Here's a list of the available keys and the
|
||||
values that they return:
|
||||
|
||||
`layout.bare`::
|
||||
`true` if this is a bare repository, otherwise `false`.
|
||||
|
||||
`layout.shallow`::
|
||||
`true` if this is a shallow repository, otherwise `false`.
|
||||
|
||||
`references.format`::
|
||||
The reference storage format. The valid values are:
|
||||
+
|
||||
include::ref-storage-format.adoc[]
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
* Retrieves the reference format of the current repository:
|
||||
+
|
||||
------------
|
||||
git repo info references.format
|
||||
------------
|
||||
+
|
||||
|
||||
* Retrieves whether the current repository is bare and whether it is shallow
|
||||
using the `nul` format:
|
||||
+
|
||||
------------
|
||||
git repo info --format=nul layout.bare layout.shallow
|
||||
------------
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
linkgit:git-rev-parse[1]
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[1] suite
|
||||
@@ -116,6 +116,7 @@ manpages = {
|
||||
'git-repack.adoc' : 1,
|
||||
'git-replace.adoc' : 1,
|
||||
'git-replay.adoc' : 1,
|
||||
'git-repo.adoc' : 1,
|
||||
'git-request-pull.adoc' : 1,
|
||||
'git-rerere.adoc' : 1,
|
||||
'git-reset.adoc' : 1,
|
||||
|
||||
Reference in New Issue
Block a user