1 Game of Trees (Got) is a version control system which prioritizes ease
2 of use and simplicity over flexibility (https://gameoftrees.org)
4 Got is still under development; it is being developed exclusively
5 on OpenBSD and its target audience are OpenBSD developers. Got is
6 ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
8 Got uses Git repositories to store versioned data. At present, Got
9 supports local version control operations only. Git can be used
10 for any functionality which has not yet been implemented in Got.
11 It will always remain possible to work with both Got and Git on
14 To compile the Got client tool suite on OpenBSD, run:
20 This will install the following commands:
22 got, the command line interface
23 tog, an ncurses-based interactive Git repository browser
24 several helper programs from the libexec directory
25 man pages (only installed if building sources from a Got release tarball)
27 A Got release tarball will install files under /usr/local by default.
28 A build started in Got's Git repository will install files under ~/bin.
30 Tests will pass only after 'make install' because they rely on installed
31 binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
32 Tests which use the got clone, fetch, and send commands will fail if
33 'ssh 127.0.0.1' does not succeed non-interactively.
38 To test with packed repositories, run:
40 $ make regress GOT_TEST_PACK=1
42 To test with packed repositories using the ref-delta representation for
43 deltified objects, run:
45 $ make regress GOT_TEST_PACK=ref-delta
47 Because got unveils the /tmp directory by default using the /tmp directory
48 for test data can hide bugs. However, /tmp remains the default because
49 there is no better alternative that works out of the box. In order to
50 store test data in a directory other than /tmp, such as ~/got-test, run:
53 $ make regress GOT_TEST_ROOT=~/got-test
55 Man page files in the Got source tree can be viewed with 'man -l':
58 $ man -l got/git-repository.5
59 $ man -l got/got-worktree.5
62 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
65 To compile the Got server tool suite on OpenBSD, run:
71 This will install the following commands:
73 gotd, the repository server program
74 gotctl, the server control utility
75 gotsh, the login shell for users accessing the server via the network
76 gitwrapper, like mailwrapper(8) but for git-upload-pack and git-receive-pack
78 See the following manual page files for information about server setup:
81 $ man -l gotd/gotd.conf.5
82 $ man -l gotctl/gotctl.8
83 $ man -l gotsh/gotsh.1
84 $ man -l gitwrapper/gitwrapper.1
86 See regress/gotd/README for information about running the server test suite.
89 Game of Trees Web Daemon (gotwebd) is a FastCGI program which displays
90 repository data and is designed to work with httpd(8).
92 To compile gotwebd on OpenBSD, run:
97 This will create the following files:
98 the daemon program /usr/local/sbin/gotwebd
99 css and image files in /var/www/htdocs/gotwebd
100 the gotwebd init script in /etc/rc.d
101 man pages (only installed if building sources from a Got release tarball)
103 Documentation is available in manual pages:
105 $ man -l gotwebd/gotwebd.8
106 $ man -l gotwebd/gotwebd.conf.5
109 Got can be built with profiling enabled to debug performance issues.
110 Note that profiled builds cannot make use of pledge(2).
111 Profiling should only be enabled for one program at a time. Otherwise,
112 multiple programs will attempt to write to the 'gmon.out' file in the
113 current working directory.
115 For example, to compile got-read-pack with profiling enabled:
117 $ cd libexec/got-read-pack
122 Running any Got command which ends up using got-read-pack should now
123 produce the file 'gmon.out' in the current working directory.
124 The gprof2dot program can be used to generate a profile graph:
126 $ doas pkg_add gprof2dot graphviz
127 $ gprof ~/bin/got-read-pack gmon.out | gprof2dot | dot -T png > profile.png
130 Guidelines for reporting problems:
132 All problem/bug reports should include a reproduction recipe in form of a
133 shell script which starts out with an empty repository and runs a series of
134 Got and/or Git commands to trigger the problem, be it a crash or some other
135 undesirable behaviour.
137 The regress/cmdline directory contains plenty of example scripts.
138 An ideal reproduction recipe is written as an xfail ("expected failure")
139 regression test. For a real-world example of an xfail test, see commits
140 4866d0842a2b34812818685aaa31d3e0a966412d and
141 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
143 Please take this request very seriously; Ask for help with writing your
144 regression test before asking for your problem to be fixed. Time invested
145 in writing a regression test saves time wasted on back-and-forth discussion
146 about how the problem can be reproduced. A regression test will need to be
147 written in any case to verify a fix and prevent the problem from resurfacing.
149 It is also possible to write test cases in C. Various examples of this
150 exist in the regress/ directory. Most such tests are unit tests; it is
151 unlikely that a problem found during regular usage will require a test
154 Some areas of code, such as the tog UI, are not covered by automated tests.
155 Please always try to find a way to trigger your problem via the command line
156 interface before reporting a problem without a written test case included.
157 If writing an automated test really turns out to be impossible, please
158 explain in very clear terms how the problem can be reproduced.
160 Mail problem reports to: gameoftrees@openbsd.org
163 Guidelines for submitting patches:
165 Mail patches to: gameoftrees@openbsd.org
166 Pull requests via any Git hosting sites will likely be overlooked.
167 Please keep the intended target audience in mind when contributing to Got.
170 Subscribing to the gameoftrees@openbsd.org mailing list:
172 The mailing list is used for patch reviews, bug reports, and user questions.
173 To subscribe, send mail to majordomo@openbsd.org with a message body of:
174 subscribe gameoftrees
176 See https://www.openbsd.org/mail.html for more information.
