Git Documentation and Configuration

Guides ------ The following documentation pages are guides about Git concepts. include::{build_dir}/cmds-guide.adoc[] Repository, command and file interfaces --------------------------------------- This documentation discusses repository and command interfaces which users are expected to interact with directly. See `--user-formats` in linkgit:git-help[1] for more details on the criteria. include::{build_dir}/cmds-userinterfaces.adoc[] File formats, protocols and other developer interfaces ------------------------------------------------------ This documentation discusses file formats, over-the-wire protocols and other git developer interfaces. See `--developer-interfaces` in linkgit:git-help[1]. include::{build_dir}/cmds-developerinterfaces.adoc[] Configuration Mechanism ----------------------- Git uses a simple text format to store customizations that are per repository and are per user. Such a configuration file may look like this: ------------ # # A '#' or ';' character indicates a comment. # ; core variables [core] ; Don't trust file modes filemode = false ; user identity [user] name = "Junio C Hamano" email = "gitster@pobox.com" ------------ Various commands read from the configuration file and adjust their operation accordingly. See linkgit:git-config[1] for a list and more details about the configuration mechanism. Identifier Terminology ---------------------- <object>:: Indicates the object name for any type of object. <blob>:: Indicates a blob object name. <tree>:: Indicates a tree object name. <commit>:: Indicates a commit object name. <tree-ish>:: Indicates a tree, commit or tag object name. A command that takes a <tree-ish> argument ultimately wants to operate on a <tree> object but automatically dereferences <commit> and <tag> objects that point at a <tree>. <commit-ish>:: Indicates a commit or tag object name. A command that takes a <commit-ish> argument ultimately wants to operate on a <commit> object but automatically dereferences <tag> objects that point at a <commit>. <type>:: Indicates that an object type is required. Currently one of: `blob`, `tree`, `commit`, or `tag`. <file>:: Indicates a filename - almost always relative to the root of the tree structure `GIT_INDEX_FILE` describes. Symbolic Identifiers -------------------- Any Git command accepting any <object> can also use the following symbolic notation: HEAD:: indicates the head of the current branch. <tag>:: a valid tag 'name' (i.e. a `refs/tags/<tag>` reference). <head>:: a valid head 'name' (i.e. a `refs/heads/<head>` reference). For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. File/Directory Structure ------------------------ Please see the linkgit:gitrepository-layout[5] document. Read linkgit:githooks[5] for more details about each hook. Higher level SCMs may provide and manage additional information in the `$GIT_DIR`. Terminology ----------- Please see linkgit:gitglossary[7]. Environment Variables --------------------- Various Git commands pay attention to environment variables and change their behavior. The environment variables marked as "Boolean" take their values the same way as Boolean valued configuration variables, i.e., "true", "yes", "on" and positive numbers are taken as "yes", while "false", "no", "off", and "0" are taken as "no". Here are the variables: System ~~~~~~ `HOME`:: Specifies the path to the user's home directory. On Windows, if unset, Git will set a process environment variable equal to: `$HOMEDRIVE$HOMEPATH` if both `$HOMEDRIVE` and `$HOMEPATH` exist; otherwise `$USERPROFILE` if `$USERPROFILE` exists. The Git Repository ~~~~~~~~~~~~~~~~~~ These environment variables apply to 'all' core Git commands. Nb: it is worth noting that they may be used/overridden by SCMS sitting above Git so take care if using a foreign front-end. `GIT_INDEX_FILE`:: This environment variable specifies

This section of the Git documentation covers various guides, repository and command interfaces, file formats, configuration mechanisms, identifier terminology, symbolic identifiers, file/directory structure, terminology, and environment variables that affect Git's behavior, providing a comprehensive overview of Git's internal workings and customization options.