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. Git can be used
9 for any functionality which has not yet been implemented in Got.
10 It will always remain possible to work with both Got and Git on
13 To compile the Got client tool suite on OpenBSD, run:
19 This will install the following commands:
21 got, the command line interface
22 tog, an ncurses-based interactive Git repository browser
23 several helper programs from the libexec directory
24 man pages (only installed if building sources from a Got release tarball)
26 A Got release tarball will install files under /usr/local by default.
27 A build started in Got's Git repository will install files under ~/bin.
29 Tests will pass only after 'make install' because they rely on installed
30 binaries in $PATH. Any tests written as shell scripts also depend on git(1).
31 Tests which use the got clone, fetch, and send commands will fail if
32 'ssh 127.0.0.1' does not succeed non-interactively.
37 To test with packed repositories, run:
39 $ make regress GOT_TEST_PACK=1
41 To test with packed repositories using the ref-delta representation for
42 deltified objects, run:
44 $ make regress GOT_TEST_PACK=ref-delta
46 Because got unveils the /tmp directory by default using the /tmp directory
47 for test data can hide bugs. However, /tmp remains the default because
48 there is no better alternative that works out of the box. In order to
49 store test data in a directory other than /tmp, such as ~/got-test, run:
52 $ make regress GOT_TEST_ROOT=~/got-test
54 To run the tog automated test suite:
58 Like Got, either individual tests or the entire suite can be run:
61 $ make # run all tests
62 $ ./log.sh # run log view tests
64 Man page files in the Got source tree can be viewed with 'man -l':
67 $ man -l got/git-repository.5
68 $ man -l got/got-worktree.5
71 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
74 To compile the Got server tool suite on OpenBSD, run:
80 This will install the following commands:
82 gotd, the repository server program
83 gotctl, the server control utility
84 gotsh, the login shell for users accessing the server via the network
85 gitwrapper, like mailwrapper(8) but for git-upload-pack and git-receive-pack
87 See the following manual page files for information about server setup:
90 $ man -l gotd/gotd.conf.5
91 $ man -l gotctl/gotctl.8
92 $ man -l gotsh/gotsh.1
93 $ man -l gitwrapper/gitwrapper.1
95 See regress/gotd/README for information about running the server test suite.
98 Game of Trees Web Daemon (gotwebd) is a FastCGI program which displays
99 repository data and is designed to work with httpd(8).
101 To compile gotwebd on OpenBSD, run:
106 This will create the following files:
107 the daemon program /usr/local/sbin/gotwebd
108 css and image files in /var/www/htdocs/gotwebd
109 the gotwebd init script in /etc/rc.d
110 man pages (only installed if building sources from a Got release tarball)
112 Documentation is available in manual pages:
114 $ man -l gotwebd/gotwebd.8
115 $ man -l gotwebd/gotwebd.conf.5
118 Got can be built with profiling enabled to debug performance issues.
119 Note that profiled builds cannot make use of pledge(2).
120 Profiling should only be enabled for one program at a time. Otherwise,
121 multiple programs will attempt to write to the 'gmon.out' file in the
122 current working directory.
124 For example, to compile got-read-pack with profiling enabled:
126 $ cd libexec/got-read-pack
131 Running any Got command which ends up using got-read-pack should now
132 produce the file 'gmon.out' in the current working directory.
133 The gprof2dot program can be used to generate a profile graph:
135 $ doas pkg_add gprof2dot graphviz
136 $ gprof ~/bin/got-read-pack gmon.out | gprof2dot | dot -T png > profile.png
139 Guidelines for reporting problems:
141 All problem/bug reports should include a reproduction recipe in form of a
142 shell script which starts out with an empty repository and runs a series of
143 Got and/or Git commands to trigger the problem, be it a crash or some other
144 undesirable behaviour.
146 The regress/cmdline directory contains plenty of example scripts.
147 An ideal reproduction recipe is written as an xfail ("expected failure")
148 regression test. For a real-world example of an xfail test, see commits
149 4866d0842a2b34812818685aaa31d3e0a966412d and
150 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
152 Please take this request very seriously; Ask for help with writing your
153 regression test before asking for your problem to be fixed. Time invested
154 in writing a regression test saves time wasted on back-and-forth discussion
155 about how the problem can be reproduced. A regression test will need to be
156 written in any case to verify a fix and prevent the problem from resurfacing.
158 It is also possible to write test cases in C. Various examples of this
159 exist in the regress/ directory. Most such tests are unit tests; it is
160 unlikely that a problem found during regular usage will require a test
163 Please always try to find a way to trigger your problem via the command line
164 interface before reporting a problem without a written test case included.
165 If writing an automated test really turns out to be impossible, please
166 explain in very clear terms how the problem can be reproduced.
168 Mail problem reports to: gameoftrees@openbsd.org
171 Guidelines for submitting patches:
173 Mail patches to: gameoftrees@openbsd.org
174 Pull requests via any Git hosting sites will likely be overlooked.
175 Please keep the intended target audience in mind when contributing to Got.
178 Subscribing to the gameoftrees@openbsd.org mailing list:
180 The mailing list is used for patch reviews, bug reports, and user questions.
181 To subscribe, send mail to majordomo@openbsd.org with a message body of:
182 subscribe gameoftrees
184 See https://www.openbsd.org/mail.html for more information.
