commit 5e5560e10410aa7dab84154c6cad083c6fd3ef76 from: Stefan Sperling date: Wed Aug 01 13:04:29 2018 UTC rename got-repository(5) man page to git-repository(5) commit - 0d0963125c0ca4e10febde6cbcf67ee85938c8e0 commit + 5e5560e10410aa7dab84154c6cad083c6fd3ef76 blob - 35d807c62260fd3c180cd2e4c412a943339a1263 (mode 644) blob + /dev/null --- got/got-repository.5 +++ /dev/null @@ -1,99 +0,0 @@ -.\" -.\" Copyright (c) 2018 Stefan Sperling -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate$ -.Dt GOT-REPOSITORY 5 -.Os -.Sh NAME -.Nm got-repository -.Nd format of -.Xr got 1 -repositories -.Sh DESCRIPTION -.Xr got 1 -stores the history of tracked files in a repository which uses -the same on-disk format as -.Dq bare -repositories used by the Git version control system. -.Pp -The repository's core data model is a directed acyclic graph which -contains three types of objects as nodes. -Each object is identified by the SHA-1 hash calculated over the object's -header plus the content stored in the object. -The object header names the type of object in an ASCII string, which is -followed by a space, followed by the size of data in the object encoded -as an ASCII number string. -This header is terminated by a -.Sy NUL -character. -.Pp -The content of files tracked under version control is stored in objects -of type -.Em blob . -.Pp -A -.Em tree -object points to any number of such blobs, and also to other trees -in order to form a hierarchy of files and directories. -.Pp -A -.Em commit -object points to the root element of one tree, and thus records the -state of this entire tree as a snapshot. -Commit objects are chained together and thus form a line of history -of snapshots. -A given commit can be suceeded by an arbitrary number of subsequent -commits, such that diverging lines of version control history, known as -.Em branches , -can be represented. -A commit which preceeds another commit is referred to as that other commit's -.Em parent commit . -A commit with multiple parents reunites diverged lines of history and is -known as a -.Em merge commit . -While the data model allows for commits with an arbitrary number of -parent commits, -.Xr got 1 -restricts all commits to at most 2 parents in order to discourage chaotic -branching and merging practices. -.Pp -When stored on disk, all objects are compressed with -.Xr deflate 3 . -Mulitple objects may be stored together in a -.Em pack file -which provides for deltification of object content. -.Sh FILES -.Bl -tag -width /etc/rpc -compact -.It Pa HEAD -.It Pa ORIG_HEAD -.It Pa FETCH_HEAD -.It Pa branches/ -.It Pa config -.It Pa description -.It Pa hooks/ -.It Pa index -.It Pa info -.It Pa logs/ -.It Pa objects/ -.It Pa packed-refs -.It Pa refs/ -.El -.Sh SEE ALSO -.Xr git 1 , -.Xr got 1 , -.Xr deflate 3 , -.Xr got-worktree 5 -.Sh HISTORY -The Git repository format was conceived by Linus Torvalds in 2005. blob - /dev/null blob + bec518e7eb43b478dc1a3d613f5deb835001f7f8 (mode 644) --- /dev/null +++ got/git-repository.5 @@ -0,0 +1,91 @@ +.\" +.\" Copyright (c) 2018 Stefan Sperling +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate$ +.Dt GIT-REPOSITORY 5 +.Os +.Sh NAME +.Nm git-repository +.Nd git repository format +.Sh DESCRIPTION +A git repository stores a series of versioned snapshots of a file hierarchy. +.Pp +The repository's core data model is a directed acyclic graph which +contains three types of objects as nodes. +Each object is identified by the SHA-1 hash calculated over the object's +header plus the content stored in the object. +The object header names the type of object in an ASCII string, which is +followed by a space, followed by the size of data in the object encoded +as an ASCII number string. +This header is terminated by a +.Sy NUL +character. +.Pp +The content of tracked files is stored in objects of type +.Em blob . +.Pp +A +.Em tree +object points to any number of such blobs, and also to other trees in +order to form a hierarchy of files and directories. +.Pp +A +.Em commit +object points to the root element of one tree, and thus records the +state of this entire tree as a snapshot. +Commit objects are chained together and thus form a line of history +of snapshots. +A given commit can be suceeded by an arbitrary number of subsequent commits, +such that diverging lines of version control history, known as +.Em branches , +can be represented. +A commit which preceeds another commit is referred to as that other commit's +.Em parent commit . +A commit with multiple parents reunites diverged lines of history and is +known as a +.Em merge commit . +While the data model allows for commits with an arbitrary number of +parent commits, +.Xr got 1 +restricts all commits to at most 2 parents in order to discourage chaotic +branching and merging practices. +.Pp +When stored on disk, all objects are compressed with +.Xr deflate 3 . +Mulitple objects may be stored together in a +.Em pack file +which provides for deltification of object content. +.Sh FILES +.Bl -tag -width /etc/rpc -compact +.It Pa HEAD +.It Pa ORIG_HEAD +.It Pa FETCH_HEAD +.It Pa branches/ +.It Pa config +.It Pa description +.It Pa hooks/ +.It Pa index +.It Pa info +.It Pa logs/ +.It Pa objects/ +.It Pa packed-refs +.It Pa refs/ +.El +.Sh SEE ALSO +.Xr got 1 , +.Xr deflate 3 , +.Xr got-worktree 5 +.Sh HISTORY +The Git repository format was designed by Linus Torvalds in 2005. blob - d08753947cf8d25b5a8bf669424775579e7cd6a8 blob + 6126ff55a0937842dec9dffdcf68c63681aec6f3 --- got/got.1 +++ got/got.1 @@ -36,7 +36,7 @@ the same on-disk format as .Dq bare repositories used by the Git version control system. This repository format is described in -.Xr got-repository 5 . +.Xr git-repository 5 . .Pp .Nm is a @@ -139,7 +139,7 @@ kernel sources from a Git repository at /var/repo/open .Pp .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys .Sh SEE ALSO -.Xr got-repository 5 +.Xr git-repository 5 .Xr got-worktree 5 .Sh AUTHORS .An Stefan Sperling Aq Mt stsp@openbsd.org blob - 6fbbf3846b3e051984607796519c11788791c07e blob + 317a0460c3863d0762a84f9c3ff292e39492445b --- tog/tog.1 +++ tog/tog.1 @@ -28,7 +28,7 @@ .Nm is an interactive read-only browser for git repositories. This repository format is described in -.Xr got-repository 5 . +.Xr git-repository 5 . .Pp .Nm provides global and command-specific options. @@ -200,6 +200,6 @@ to a commit object. .Sh EXIT STATUS .Ex -std tog .Sh SEE ALSO -.Xr got-repository 5 +.Xr git-repository 5 .Sh AUTHORS .An Stefan Sperling Aq Mt stsp@openbsd.org