Experimenting with making pretty man pages on paper.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1092 lines
27 KiB

  1. '\" t
  2. .\" Title: gitglossary
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 03/04/2021
  6. .\" Manual: Git Manual
  7. .\" Source: Git 2.25.1
  8. .\" Language: English
  9. .\"
  10. .TH "GITGLOSSARY" "7" "03/04/2021" "Git 2\&.25\&.1" "Git Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. gitglossary \- A Git Glossary
  32. .SH "SYNOPSIS"
  33. .sp
  34. *
  35. .SH "DESCRIPTION"
  36. .PP
  37. alternate object database
  38. .RS 4
  39. Via the alternates mechanism, a
  40. repository
  41. can inherit part of its
  42. object database
  43. from another object database, which is called an "alternate"\&.
  44. .RE
  45. .PP
  46. bare repository
  47. .RS 4
  48. A bare repository is normally an appropriately named
  49. directory
  50. with a
  51. \fB\&.git\fR
  52. suffix that does not have a locally checked\-out copy of any of the files under revision control\&. That is, all of the Git administrative and control files that would normally be present in the hidden
  53. \fB\&.git\fR
  54. sub\-directory are directly present in the
  55. \fBrepository\&.git\fR
  56. directory instead, and no other files are present and checked out\&. Usually publishers of public repositories make bare repositories available\&.
  57. .RE
  58. .PP
  59. blob object
  60. .RS 4
  61. Untyped
  62. object, e\&.g\&. the contents of a file\&.
  63. .RE
  64. .PP
  65. branch
  66. .RS 4
  67. A "branch" is an active line of development\&. The most recent
  68. commit
  69. on a branch is referred to as the tip of that branch\&. The tip of the branch is referenced by a branch
  70. head, which moves forward as additional development is done on the branch\&. A single Git
  71. repository
  72. can track an arbitrary number of branches, but your
  73. working tree
  74. is associated with just one of them (the "current" or "checked out" branch), and
  75. HEAD
  76. points to that branch\&.
  77. .RE
  78. .PP
  79. cache
  80. .RS 4
  81. Obsolete for:
  82. index\&.
  83. .RE
  84. .PP
  85. chain
  86. .RS 4
  87. A list of objects, where each
  88. object
  89. in the list contains a reference to its successor (for example, the successor of a
  90. commit
  91. could be one of its
  92. parents)\&.
  93. .RE
  94. .PP
  95. changeset
  96. .RS 4
  97. BitKeeper/cvsps speak for "commit"\&. Since Git does not store changes, but states, it really does not make sense to use the term "changesets" with Git\&.
  98. .RE
  99. .PP
  100. checkout
  101. .RS 4
  102. The action of updating all or part of the
  103. working tree
  104. with a
  105. tree object
  106. or
  107. blob
  108. from the
  109. object database, and updating the
  110. index
  111. and
  112. HEAD
  113. if the whole working tree has been pointed at a new
  114. branch\&.
  115. .RE
  116. .PP
  117. cherry\-picking
  118. .RS 4
  119. In
  120. SCM
  121. jargon, "cherry pick" means to choose a subset of changes out of a series of changes (typically commits) and record them as a new series of changes on top of a different codebase\&. In Git, this is performed by the "git cherry\-pick" command to extract the change introduced by an existing
  122. commit
  123. and to record it based on the tip of the current
  124. branch
  125. as a new commit\&.
  126. .RE
  127. .PP
  128. clean
  129. .RS 4
  130. A
  131. working tree
  132. is clean, if it corresponds to the
  133. revision
  134. referenced by the current
  135. head\&. Also see "dirty"\&.
  136. .RE
  137. .PP
  138. commit
  139. .RS 4
  140. As a noun: A single point in the Git history; the entire history of a project is represented as a set of interrelated commits\&. The word "commit" is often used by Git in the same places other revision control systems use the words "revision" or "version"\&. Also used as a short hand for
  141. commit object\&.
  142. .sp
  143. As a verb: The action of storing a new snapshot of the project\(cqs state in the Git history, by creating a new commit representing the current state of the
  144. index
  145. and advancing
  146. HEAD
  147. to point at the new commit\&.
  148. .RE
  149. .PP
  150. commit object
  151. .RS 4
  152. An
  153. object
  154. which contains the information about a particular
  155. revision, such as
  156. parents, committer, author, date and the
  157. tree object
  158. which corresponds to the top
  159. directory
  160. of the stored revision\&.
  161. .RE
  162. .PP
  163. commit\-ish (also committish)
  164. .RS 4
  165. A
  166. commit object
  167. or an
  168. object
  169. that can be recursively dereferenced to a commit object\&. The following are all commit\-ishes: a commit object, a
  170. tag object
  171. that points to a commit object, a tag object that points to a tag object that points to a commit object, etc\&.
  172. .RE
  173. .PP
  174. core Git
  175. .RS 4
  176. Fundamental data structures and utilities of Git\&. Exposes only limited source code management tools\&.
  177. .RE
  178. .PP
  179. DAG
  180. .RS 4
  181. Directed acyclic graph\&. The
  182. commit objects
  183. form a directed acyclic graph, because they have parents (directed), and the graph of commit objects is acyclic (there is no
  184. chain
  185. which begins and ends with the same
  186. object)\&.
  187. .RE
  188. .PP
  189. dangling object
  190. .RS 4
  191. An
  192. unreachable object
  193. which is not
  194. reachable
  195. even from other unreachable objects; a dangling object has no references to it from any reference or
  196. object
  197. in the
  198. repository\&.
  199. .RE
  200. .PP
  201. detached HEAD
  202. .RS 4
  203. Normally the
  204. HEAD
  205. stores the name of a
  206. branch, and commands that operate on the history HEAD represents operate on the history leading to the tip of the branch the HEAD points at\&. However, Git also allows you to
  207. check out
  208. an arbitrary
  209. commit
  210. that isn\(cqt necessarily the tip of any particular branch\&. The HEAD in such a state is called "detached"\&.
  211. .sp
  212. Note that commands that operate on the history of the current branch (e\&.g\&.
  213. \fBgit commit\fR
  214. to build a new history on top of it) still work while the HEAD is detached\&. They update the HEAD to point at the tip of the updated history without affecting any branch\&. Commands that update or inquire information
  215. \fIabout\fR
  216. the current branch (e\&.g\&.
  217. \fBgit branch \-\-set\-upstream\-to\fR
  218. that sets what remote\-tracking branch the current branch integrates with) obviously do not work, as there is no (real) current branch to ask about in this state\&.
  219. .RE
  220. .PP
  221. directory
  222. .RS 4
  223. The list you get with "ls" :\-)
  224. .RE
  225. .PP
  226. dirty
  227. .RS 4
  228. A
  229. working tree
  230. is said to be "dirty" if it contains modifications which have not been
  231. committed
  232. to the current
  233. branch\&.
  234. .RE
  235. .PP
  236. evil merge
  237. .RS 4
  238. An evil merge is a
  239. merge
  240. that introduces changes that do not appear in any
  241. parent\&.
  242. .RE
  243. .PP
  244. fast\-forward
  245. .RS 4
  246. A fast\-forward is a special type of
  247. merge
  248. where you have a
  249. revision
  250. and you are "merging" another
  251. branch\*(Aqs changes that happen to be a descendant of what you have\&. In such a case, you do not make a new
  252. merge
  253. commit
  254. but instead just update to his revision\&. This will happen frequently on a
  255. remote\-tracking branch
  256. of a remote
  257. repository\&.
  258. .RE
  259. .PP
  260. fetch
  261. .RS 4
  262. Fetching a
  263. branch
  264. means to get the branch\(cqs
  265. head ref
  266. from a remote
  267. repository, to find out which objects are missing from the local
  268. object database, and to get them, too\&. See also
  269. \fBgit-fetch\fR(1)\&.
  270. .RE
  271. .PP
  272. file system
  273. .RS 4
  274. Linus Torvalds originally designed Git to be a user space file system, i\&.e\&. the infrastructure to hold files and directories\&. That ensured the efficiency and speed of Git\&.
  275. .RE
  276. .PP
  277. Git archive
  278. .RS 4
  279. Synonym for
  280. repository
  281. (for arch people)\&.
  282. .RE
  283. .PP
  284. gitfile
  285. .RS 4
  286. A plain file
  287. \fB\&.git\fR
  288. at the root of a working tree that points at the directory that is the real repository\&.
  289. .RE
  290. .PP
  291. grafts
  292. .RS 4
  293. Grafts enables two otherwise different lines of development to be joined together by recording fake ancestry information for commits\&. This way you can make Git pretend the set of
  294. parents
  295. a
  296. commit
  297. has is different from what was recorded when the commit was created\&. Configured via the
  298. \fB\&.git/info/grafts\fR
  299. file\&.
  300. .sp
  301. Note that the grafts mechanism is outdated and can lead to problems transferring objects between repositories; see
  302. \fBgit-replace\fR(1)
  303. for a more flexible and robust system to do the same thing\&.
  304. .RE
  305. .PP
  306. hash
  307. .RS 4
  308. In Git\(cqs context, synonym for
  309. object name\&.
  310. .RE
  311. .PP
  312. head
  313. .RS 4
  314. A
  315. named reference
  316. to the
  317. commit
  318. at the tip of a
  319. branch\&. Heads are stored in a file in
  320. \fB$GIT_DIR/refs/heads/\fR
  321. directory, except when using packed refs\&. (See
  322. \fBgit-pack-refs\fR(1)\&.)
  323. .RE
  324. .PP
  325. HEAD
  326. .RS 4
  327. The current
  328. branch\&. In more detail: Your
  329. working tree
  330. is normally derived from the state of the tree referred to by HEAD\&. HEAD is a reference to one of the
  331. heads
  332. in your repository, except when using a
  333. detached HEAD, in which case it directly references an arbitrary commit\&.
  334. .RE
  335. .PP
  336. head ref
  337. .RS 4
  338. A synonym for
  339. head\&.
  340. .RE
  341. .PP
  342. hook
  343. .RS 4
  344. During the normal execution of several Git commands, call\-outs are made to optional scripts that allow a developer to add functionality or checking\&. Typically, the hooks allow for a command to be pre\-verified and potentially aborted, and allow for a post\-notification after the operation is done\&. The hook scripts are found in the
  345. \fB$GIT_DIR/hooks/\fR
  346. directory, and are enabled by simply removing the
  347. \fB\&.sample\fR
  348. suffix from the filename\&. In earlier versions of Git you had to make them executable\&.
  349. .RE
  350. .PP
  351. index
  352. .RS 4
  353. A collection of files with stat information, whose contents are stored as objects\&. The index is a stored version of your
  354. working tree\&. Truth be told, it can also contain a second, and even a third version of a working tree, which are used when
  355. merging\&.
  356. .RE
  357. .PP
  358. index entry
  359. .RS 4
  360. The information regarding a particular file, stored in the
  361. index\&. An index entry can be unmerged, if a
  362. merge
  363. was started, but not yet finished (i\&.e\&. if the index contains multiple versions of that file)\&.
  364. .RE
  365. .PP
  366. master
  367. .RS 4
  368. The default development
  369. branch\&. Whenever you create a Git
  370. repository, a branch named "master" is created, and becomes the active branch\&. In most cases, this contains the local development, though that is purely by convention and is not required\&.
  371. .RE
  372. .PP
  373. merge
  374. .RS 4
  375. As a verb: To bring the contents of another
  376. branch
  377. (possibly from an external
  378. repository) into the current branch\&. In the case where the merged\-in branch is from a different repository, this is done by first
  379. fetching
  380. the remote branch and then merging the result into the current branch\&. This combination of fetch and merge operations is called a
  381. pull\&. Merging is performed by an automatic process that identifies changes made since the branches diverged, and then applies all those changes together\&. In cases where changes conflict, manual intervention may be required to complete the merge\&.
  382. .sp
  383. As a noun: unless it is a
  384. fast\-forward, a successful merge results in the creation of a new
  385. commit
  386. representing the result of the merge, and having as
  387. parents
  388. the tips of the merged
  389. branches\&. This commit is referred to as a "merge commit", or sometimes just a "merge"\&.
  390. .RE
  391. .PP
  392. object
  393. .RS 4
  394. The unit of storage in Git\&. It is uniquely identified by the
  395. SHA\-1
  396. of its contents\&. Consequently, an object cannot be changed\&.
  397. .RE
  398. .PP
  399. object database
  400. .RS 4
  401. Stores a set of "objects", and an individual
  402. object
  403. is identified by its
  404. object name\&. The objects usually live in
  405. \fB$GIT_DIR/objects/\fR\&.
  406. .RE
  407. .PP
  408. object identifier
  409. .RS 4
  410. Synonym for
  411. object name\&.
  412. .RE
  413. .PP
  414. object name
  415. .RS 4
  416. The unique identifier of an
  417. object\&. The object name is usually represented by a 40 character hexadecimal string\&. Also colloquially called
  418. SHA\-1\&.
  419. .RE
  420. .PP
  421. object type
  422. .RS 4
  423. One of the identifiers "commit", "tree", "tag" or "blob" describing the type of an
  424. object\&.
  425. .RE
  426. .PP
  427. octopus
  428. .RS 4
  429. To
  430. merge
  431. more than two
  432. branches\&.
  433. .RE
  434. .PP
  435. origin
  436. .RS 4
  437. The default upstream
  438. repository\&. Most projects have at least one upstream project which they track\&. By default
  439. \fIorigin\fR
  440. is used for that purpose\&. New upstream updates will be fetched into
  441. remote\-tracking branches
  442. named origin/name\-of\-upstream\-branch, which you can see using
  443. \fBgit branch \-r\fR\&.
  444. .RE
  445. .PP
  446. overlay
  447. .RS 4
  448. Only update and add files to the working directory, but don\(cqt delete them, similar to how
  449. \fIcp \-R\fR
  450. would update the contents in the destination directory\&. This is the default mode in a
  451. checkout
  452. when checking out files from the
  453. index
  454. or a
  455. tree\-ish\&. In contrast, no\-overlay mode also deletes tracked files not present in the source, similar to
  456. \fIrsync \-\-delete\fR\&.
  457. .RE
  458. .PP
  459. pack
  460. .RS 4
  461. A set of objects which have been compressed into one file (to save space or to transmit them efficiently)\&.
  462. .RE
  463. .PP
  464. pack index
  465. .RS 4
  466. The list of identifiers, and other information, of the objects in a
  467. pack, to assist in efficiently accessing the contents of a pack\&.
  468. .RE
  469. .PP
  470. pathspec
  471. .RS 4
  472. Pattern used to limit paths in Git commands\&.
  473. .sp
  474. Pathspecs are used on the command line of "git ls\-files", "git ls\-tree", "git add", "git grep", "git diff", "git checkout", and many other commands to limit the scope of operations to some subset of the tree or worktree\&. See the documentation of each command for whether paths are relative to the current directory or toplevel\&. The pathspec syntax is as follows:
  475. .sp
  476. .RS 4
  477. .ie n \{\
  478. \h'-04'\(bu\h'+03'\c
  479. .\}
  480. .el \{\
  481. .sp -1
  482. .IP \(bu 2.3
  483. .\}
  484. any path matches itself
  485. .RE
  486. .sp
  487. .RS 4
  488. .ie n \{\
  489. \h'-04'\(bu\h'+03'\c
  490. .\}
  491. .el \{\
  492. .sp -1
  493. .IP \(bu 2.3
  494. .\}
  495. the pathspec up to the last slash represents a directory prefix\&. The scope of that pathspec is limited to that subtree\&.
  496. .RE
  497. .sp
  498. .RS 4
  499. .ie n \{\
  500. \h'-04'\(bu\h'+03'\c
  501. .\}
  502. .el \{\
  503. .sp -1
  504. .IP \(bu 2.3
  505. .\}
  506. the rest of the pathspec is a pattern for the remainder of the pathname\&. Paths relative to the directory prefix will be matched against that pattern using fnmatch(3); in particular,
  507. \fI*\fR
  508. and
  509. \fI?\fR
  510. \fIcan\fR
  511. match directory separators\&.
  512. .RE
  513. .sp
  514. For example, Documentation/*\&.jpg will match all \&.jpg files in the Documentation subtree, including Documentation/chapter_1/figure_1\&.jpg\&.
  515. .sp
  516. A pathspec that begins with a colon
  517. \fB:\fR
  518. has special meaning\&. In the short form, the leading colon
  519. \fB:\fR
  520. is followed by zero or more "magic signature" letters (which optionally is terminated by another colon
  521. \fB:\fR), and the remainder is the pattern to match against the path\&. The "magic signature" consists of ASCII symbols that are neither alphanumeric, glob, regex special characters nor colon\&. The optional colon that terminates the "magic signature" can be omitted if the pattern begins with a character that does not belong to "magic signature" symbol set and is not a colon\&.
  522. .sp
  523. In the long form, the leading colon
  524. \fB:\fR
  525. is followed by an open parenthesis
  526. \fB(\fR, a comma\-separated list of zero or more "magic words", and a close parentheses
  527. \fB)\fR, and the remainder is the pattern to match against the path\&.
  528. .sp
  529. A pathspec with only a colon means "there is no pathspec"\&. This form should not be combined with other pathspec\&.
  530. .PP
  531. top
  532. .RS 4
  533. The magic word
  534. \fBtop\fR
  535. (magic signature:
  536. \fB/\fR) makes the pattern match from the root of the working tree, even when you are running the command from inside a subdirectory\&.
  537. .RE
  538. .PP
  539. literal
  540. .RS 4
  541. Wildcards in the pattern such as
  542. \fB*\fR
  543. or
  544. \fB?\fR
  545. are treated as literal characters\&.
  546. .RE
  547. .PP
  548. icase
  549. .RS 4
  550. Case insensitive match\&.
  551. .RE
  552. .PP
  553. glob
  554. .RS 4
  555. Git treats the pattern as a shell glob suitable for consumption by fnmatch(3) with the FNM_PATHNAME flag: wildcards in the pattern will not match a / in the pathname\&. For example, "Documentation/*\&.html" matches "Documentation/git\&.html" but not "Documentation/ppc/ppc\&.html" or "tools/perf/Documentation/perf\&.html"\&.
  556. .sp
  557. Two consecutive asterisks ("\fB**\fR") in patterns matched against full pathname may have special meaning:
  558. .sp
  559. .RS 4
  560. .ie n \{\
  561. \h'-04'\(bu\h'+03'\c
  562. .\}
  563. .el \{\
  564. .sp -1
  565. .IP \(bu 2.3
  566. .\}
  567. A leading "\fB**\fR" followed by a slash means match in all directories\&. For example, "\fB**/foo\fR" matches file or directory "\fBfoo\fR" anywhere, the same as pattern "\fBfoo\fR"\&. "\fB**/foo/bar\fR" matches file or directory "\fBbar\fR" anywhere that is directly under directory "\fBfoo\fR"\&.
  568. .RE
  569. .sp
  570. .RS 4
  571. .ie n \{\
  572. \h'-04'\(bu\h'+03'\c
  573. .\}
  574. .el \{\
  575. .sp -1
  576. .IP \(bu 2.3
  577. .\}
  578. A trailing "\fB/**\fR" matches everything inside\&. For example, "\fBabc/**\fR" matches all files inside directory "abc", relative to the location of the
  579. \fB\&.gitignore\fR
  580. file, with infinite depth\&.
  581. .RE
  582. .sp
  583. .RS 4
  584. .ie n \{\
  585. \h'-04'\(bu\h'+03'\c
  586. .\}
  587. .el \{\
  588. .sp -1
  589. .IP \(bu 2.3
  590. .\}
  591. A slash followed by two consecutive asterisks then a slash matches zero or more directories\&. For example, "\fBa/**/b\fR" matches "\fBa/b\fR", "\fBa/x/b\fR", "\fBa/x/y/b\fR" and so on\&.
  592. .RE
  593. .sp
  594. .RS 4
  595. .ie n \{\
  596. \h'-04'\(bu\h'+03'\c
  597. .\}
  598. .el \{\
  599. .sp -1
  600. .IP \(bu 2.3
  601. .\}
  602. Other consecutive asterisks are considered invalid\&.
  603. .sp
  604. Glob magic is incompatible with literal magic\&.
  605. .RE
  606. .RE
  607. .PP
  608. attr
  609. .RS 4
  610. After
  611. \fBattr:\fR
  612. comes a space separated list of "attribute requirements", all of which must be met in order for the path to be considered a match; this is in addition to the usual non\-magic pathspec pattern matching\&. See
  613. \fBgitattributes\fR(5)\&.
  614. .sp
  615. Each of the attribute requirements for the path takes one of these forms:
  616. .sp
  617. .RS 4
  618. .ie n \{\
  619. \h'-04'\(bu\h'+03'\c
  620. .\}
  621. .el \{\
  622. .sp -1
  623. .IP \(bu 2.3
  624. .\}
  625. "\fBATTR\fR" requires that the attribute
  626. \fBATTR\fR
  627. be set\&.
  628. .RE
  629. .sp
  630. .RS 4
  631. .ie n \{\
  632. \h'-04'\(bu\h'+03'\c
  633. .\}
  634. .el \{\
  635. .sp -1
  636. .IP \(bu 2.3
  637. .\}
  638. "\fB\-ATTR\fR" requires that the attribute
  639. \fBATTR\fR
  640. be unset\&.
  641. .RE
  642. .sp
  643. .RS 4
  644. .ie n \{\
  645. \h'-04'\(bu\h'+03'\c
  646. .\}
  647. .el \{\
  648. .sp -1
  649. .IP \(bu 2.3
  650. .\}
  651. "\fBATTR=VALUE\fR" requires that the attribute
  652. \fBATTR\fR
  653. be set to the string
  654. \fBVALUE\fR\&.
  655. .RE
  656. .sp
  657. .RS 4
  658. .ie n \{\
  659. \h'-04'\(bu\h'+03'\c
  660. .\}
  661. .el \{\
  662. .sp -1
  663. .IP \(bu 2.3
  664. .\}
  665. "\fB!ATTR\fR" requires that the attribute
  666. \fBATTR\fR
  667. be unspecified\&.
  668. .sp
  669. Note that when matching against a tree object, attributes are still obtained from working tree, not from the given tree object\&.
  670. .RE
  671. .RE
  672. .PP
  673. exclude
  674. .RS 4
  675. After a path matches any non\-exclude pathspec, it will be run through all exclude pathspecs (magic signature:
  676. \fB!\fR
  677. or its synonym
  678. \fB^\fR)\&. If it matches, the path is ignored\&. When there is no non\-exclude pathspec, the exclusion is applied to the result set as if invoked without any pathspec\&.
  679. .RE
  680. .RE
  681. .PP
  682. parent
  683. .RS 4
  684. A
  685. commit object
  686. contains a (possibly empty) list of the logical predecessor(s) in the line of development, i\&.e\&. its parents\&.
  687. .RE
  688. .PP
  689. pickaxe
  690. .RS 4
  691. The term
  692. pickaxe
  693. refers to an option to the diffcore routines that help select changes that add or delete a given text string\&. With the
  694. \fB\-\-pickaxe\-all\fR
  695. option, it can be used to view the full
  696. changeset
  697. that introduced or removed, say, a particular line of text\&. See
  698. \fBgit-diff\fR(1)\&.
  699. .RE
  700. .PP
  701. plumbing
  702. .RS 4
  703. Cute name for
  704. core Git\&.
  705. .RE
  706. .PP
  707. porcelain
  708. .RS 4
  709. Cute name for programs and program suites depending on
  710. core Git, presenting a high level access to core Git\&. Porcelains expose more of a
  711. SCM
  712. interface than the
  713. plumbing\&.
  714. .RE
  715. .PP
  716. per\-worktree ref
  717. .RS 4
  718. Refs that are per\-worktree, rather than global\&. This is presently only
  719. HEAD
  720. and any refs that start with
  721. \fBrefs/bisect/\fR, but might later include other unusual refs\&.
  722. .RE
  723. .PP
  724. pseudoref
  725. .RS 4
  726. Pseudorefs are a class of files under
  727. \fB$GIT_DIR\fR
  728. which behave like refs for the purposes of rev\-parse, but which are treated specially by git\&. Pseudorefs both have names that are all\-caps, and always start with a line consisting of a
  729. SHA\-1
  730. followed by whitespace\&. So, HEAD is not a pseudoref, because it is sometimes a symbolic ref\&. They might optionally contain some additional data\&.
  731. \fBMERGE_HEAD\fR
  732. and
  733. \fBCHERRY_PICK_HEAD\fR
  734. are examples\&. Unlike
  735. per\-worktree refs, these files cannot be symbolic refs, and never have reflogs\&. They also cannot be updated through the normal ref update machinery\&. Instead, they are updated by directly writing to the files\&. However, they can be read as if they were refs, so
  736. \fBgit rev\-parse MERGE_HEAD\fR
  737. will work\&.
  738. .RE
  739. .PP
  740. pull
  741. .RS 4
  742. Pulling a
  743. branch
  744. means to
  745. fetch
  746. it and
  747. merge
  748. it\&. See also
  749. \fBgit-pull\fR(1)\&.
  750. .RE
  751. .PP
  752. push
  753. .RS 4
  754. Pushing a
  755. branch
  756. means to get the branch\(cqs
  757. head ref
  758. from a remote
  759. repository, find out if it is an ancestor to the branch\(cqs local head ref, and in that case, putting all objects, which are
  760. reachable
  761. from the local head ref, and which are missing from the remote repository, into the remote
  762. object database, and updating the remote head ref\&. If the remote
  763. head
  764. is not an ancestor to the local head, the push fails\&.
  765. .RE
  766. .PP
  767. reachable
  768. .RS 4
  769. All of the ancestors of a given
  770. commit
  771. are said to be "reachable" from that commit\&. More generally, one
  772. object
  773. is reachable from another if we can reach the one from the other by a
  774. chain
  775. that follows
  776. tags
  777. to whatever they tag,
  778. commits
  779. to their parents or trees, and
  780. trees
  781. to the trees or
  782. blobs
  783. that they contain\&.
  784. .RE
  785. .PP
  786. rebase
  787. .RS 4
  788. To reapply a series of changes from a
  789. branch
  790. to a different base, and reset the
  791. head
  792. of that branch to the result\&.
  793. .RE
  794. .PP
  795. ref
  796. .RS 4
  797. A name that begins with
  798. \fBrefs/\fR
  799. (e\&.g\&.
  800. \fBrefs/heads/master\fR) that points to an
  801. object name
  802. or another ref (the latter is called a
  803. symbolic ref)\&. For convenience, a ref can sometimes be abbreviated when used as an argument to a Git command; see
  804. \fBgitrevisions\fR(7)
  805. for details\&. Refs are stored in the
  806. repository\&.
  807. .sp
  808. The ref namespace is hierarchical\&. Different subhierarchies are used for different purposes (e\&.g\&. the
  809. \fBrefs/heads/\fR
  810. hierarchy is used to represent local branches)\&.
  811. .sp
  812. There are a few special\-purpose refs that do not begin with
  813. \fBrefs/\fR\&. The most notable example is
  814. \fBHEAD\fR\&.
  815. .RE
  816. .PP
  817. reflog
  818. .RS 4
  819. A reflog shows the local "history" of a ref\&. In other words, it can tell you what the 3rd last revision in
  820. \fIthis\fR
  821. repository was, and what was the current state in
  822. \fIthis\fR
  823. repository, yesterday 9:14pm\&. See
  824. \fBgit-reflog\fR(1)
  825. for details\&.
  826. .RE
  827. .PP
  828. refspec
  829. .RS 4
  830. A "refspec" is used by
  831. fetch
  832. and
  833. push
  834. to describe the mapping between remote
  835. ref
  836. and local ref\&.
  837. .RE
  838. .PP
  839. remote repository
  840. .RS 4
  841. A
  842. repository
  843. which is used to track the same project but resides somewhere else\&. To communicate with remotes, see
  844. fetch
  845. or
  846. push\&.
  847. .RE
  848. .PP
  849. remote\-tracking branch
  850. .RS 4
  851. A
  852. ref
  853. that is used to follow changes from another
  854. repository\&. It typically looks like
  855. \fIrefs/remotes/foo/bar\fR
  856. (indicating that it tracks a branch named
  857. \fIbar\fR
  858. in a remote named
  859. \fIfoo\fR), and matches the right\-hand\-side of a configured fetch
  860. refspec\&. A remote\-tracking branch should not contain direct modifications or have local commits made to it\&.
  861. .RE
  862. .PP
  863. repository
  864. .RS 4
  865. A collection of
  866. refs
  867. together with an
  868. object database
  869. containing all objects which are
  870. reachable
  871. from the refs, possibly accompanied by meta data from one or more
  872. porcelains\&. A repository can share an object database with other repositories via
  873. alternates mechanism\&.
  874. .RE
  875. .PP
  876. resolve
  877. .RS 4
  878. The action of fixing up manually what a failed automatic
  879. merge
  880. left behind\&.
  881. .RE
  882. .PP
  883. revision
  884. .RS 4
  885. Synonym for
  886. commit
  887. (the noun)\&.
  888. .RE
  889. .PP
  890. rewind
  891. .RS 4
  892. To throw away part of the development, i\&.e\&. to assign the
  893. head
  894. to an earlier
  895. revision\&.
  896. .RE
  897. .PP
  898. SCM
  899. .RS 4
  900. Source code management (tool)\&.
  901. .RE
  902. .PP
  903. SHA\-1
  904. .RS 4
  905. "Secure Hash Algorithm 1"; a cryptographic hash function\&. In the context of Git used as a synonym for
  906. object name\&.
  907. .RE
  908. .PP
  909. shallow clone
  910. .RS 4
  911. Mostly a synonym to
  912. shallow repository
  913. but the phrase makes it more explicit that it was created by running
  914. \fBgit clone \-\-depth=\&.\&.\&.\fR
  915. command\&.
  916. .RE
  917. .PP
  918. shallow repository
  919. .RS 4
  920. A shallow
  921. repository
  922. has an incomplete history some of whose
  923. commits
  924. have
  925. parents
  926. cauterized away (in other words, Git is told to pretend that these commits do not have the parents, even though they are recorded in the
  927. commit object)\&. This is sometimes useful when you are interested only in the recent history of a project even though the real history recorded in the upstream is much larger\&. A shallow repository is created by giving the
  928. \fB\-\-depth\fR
  929. option to
  930. \fBgit-clone\fR(1), and its history can be later deepened with
  931. \fBgit-fetch\fR(1)\&.
  932. .RE
  933. .PP
  934. stash entry
  935. .RS 4
  936. An
  937. object
  938. used to temporarily store the contents of a
  939. dirty
  940. working directory and the index for future reuse\&.
  941. .RE
  942. .PP
  943. submodule
  944. .RS 4
  945. A
  946. repository
  947. that holds the history of a separate project inside another repository (the latter of which is called
  948. superproject)\&.
  949. .RE
  950. .PP
  951. superproject
  952. .RS 4
  953. A
  954. repository
  955. that references repositories of other projects in its working tree as
  956. submodules\&. The superproject knows about the names of (but does not hold copies of) commit objects of the contained submodules\&.
  957. .RE
  958. .PP
  959. symref
  960. .RS 4
  961. Symbolic reference: instead of containing the
  962. SHA\-1
  963. id itself, it is of the format
  964. \fIref: refs/some/thing\fR
  965. and when referenced, it recursively dereferences to this reference\&.
  966. \fIHEAD\fR
  967. is a prime example of a symref\&. Symbolic references are manipulated with the
  968. \fBgit-symbolic-ref\fR(1)
  969. command\&.
  970. .RE
  971. .PP
  972. tag
  973. .RS 4
  974. A
  975. ref
  976. under
  977. \fBrefs/tags/\fR
  978. namespace that points to an object of an arbitrary type (typically a tag points to either a
  979. tag
  980. or a
  981. commit object)\&. In contrast to a
  982. head, a tag is not updated by the
  983. \fBcommit\fR
  984. command\&. A Git tag has nothing to do with a Lisp tag (which would be called an
  985. object type
  986. in Git\(cqs context)\&. A tag is most typically used to mark a particular point in the commit ancestry
  987. chain\&.
  988. .RE
  989. .PP
  990. tag object
  991. .RS 4
  992. An
  993. object
  994. containing a
  995. ref
  996. pointing to another object, which can contain a message just like a
  997. commit object\&. It can also contain a (PGP) signature, in which case it is called a "signed tag object"\&.
  998. .RE
  999. .PP
  1000. topic branch
  1001. .RS 4
  1002. A regular Git
  1003. branch
  1004. that is used by a developer to identify a conceptual line of development\&. Since branches are very easy and inexpensive, it is often desirable to have several small branches that each contain very well defined concepts or small incremental yet related changes\&.
  1005. .RE
  1006. .PP
  1007. tree
  1008. .RS 4
  1009. Either a
  1010. working tree, or a
  1011. tree object
  1012. together with the dependent
  1013. blob
  1014. and tree objects (i\&.e\&. a stored representation of a working tree)\&.
  1015. .RE
  1016. .PP
  1017. tree object
  1018. .RS 4
  1019. An
  1020. object
  1021. containing a list of file names and modes along with refs to the associated blob and/or tree objects\&. A
  1022. tree
  1023. is equivalent to a
  1024. directory\&.
  1025. .RE
  1026. .PP
  1027. tree\-ish (also treeish)
  1028. .RS 4
  1029. A
  1030. tree object
  1031. or an
  1032. object
  1033. that can be recursively dereferenced to a tree object\&. Dereferencing a
  1034. commit object
  1035. yields the tree object corresponding to the
  1036. revision\*(Aqs top
  1037. directory\&. The following are all tree\-ishes: a
  1038. commit\-ish, a tree object, a
  1039. tag object
  1040. that points to a tree object, a tag object that points to a tag object that points to a tree object, etc\&.
  1041. .RE
  1042. .PP
  1043. unmerged index
  1044. .RS 4
  1045. An
  1046. index
  1047. which contains unmerged
  1048. index entries\&.
  1049. .RE
  1050. .PP
  1051. unreachable object
  1052. .RS 4
  1053. An
  1054. object
  1055. which is not
  1056. reachable
  1057. from a
  1058. branch,
  1059. tag, or any other reference\&.
  1060. .RE
  1061. .PP
  1062. upstream branch
  1063. .RS 4
  1064. The default
  1065. branch
  1066. that is merged into the branch in question (or the branch in question is rebased onto)\&. It is configured via branch\&.<name>\&.remote and branch\&.<name>\&.merge\&. If the upstream branch of
  1067. \fIA\fR
  1068. is
  1069. \fIorigin/B\fR
  1070. sometimes we say "\fIA\fR
  1071. is tracking
  1072. \fIorigin/B\fR"\&.
  1073. .RE
  1074. .PP
  1075. working tree
  1076. .RS 4
  1077. The tree of actual checked out files\&. The working tree normally contains the contents of the
  1078. HEAD
  1079. commit\(cqs tree, plus any local changes that you have made but not yet committed\&.
  1080. .RE
  1081. .SH "SEE ALSO"
  1082. .sp
  1083. \fBgittutorial\fR(7), \fBgittutorial-2\fR(7), \fBgitcvs-migration\fR(7), \fBgiteveryday\fR(7), \m[blue]\fBThe Git User\(cqs Manual\fR\m[]\&\s-2\u[1]\d\s+2
  1084. .SH "GIT"
  1085. .sp
  1086. Part of the \fBgit\fR(1) suite
  1087. .SH "NOTES"
  1088. .IP " 1." 4
  1089. The Git User\(cqs Manual
  1090. .RS 4
  1091. \%file:///usr/share/doc/git/html/user-manual.html
  1092. .RE