1 c75df689 2019-07-14 stsp Game of Trees (Got) is a version control system which prioritizes ease
2 37486c75 2020-03-05 stsp of use and simplicity over flexibility (https://gameoftrees.org)
4 66164023 2019-08-09 stsp Got is still under development; it is being developed exclusively
5 66164023 2019-08-09 stsp on OpenBSD and its target audience are OpenBSD developers. Got is
6 66164023 2019-08-09 stsp ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
8 3682a04d 2023-04-14 thomas Got uses Git repositories to store versioned data. Git can be used
9 66164023 2019-08-09 stsp for any functionality which has not yet been implemented in Got.
10 66164023 2019-08-09 stsp It will always remain possible to work with both Got and Git on
11 66164023 2019-08-09 stsp the same repository.
13 71641cee 2023-06-22 thomas A Got release tarball will install files under /usr/local by default.
14 71641cee 2023-06-22 thomas This default can be changed by passing PREFIX=/some/path to make.
16 71641cee 2023-06-22 thomas A build started in Got's Git repository will install files under ~/bin,
17 71641cee 2023-06-22 thomas which may have to be added to $PATH and be created first:
19 71641cee 2023-06-22 thomas $ mkdir ~/bin
21 3efd8e31 2022-10-23 thomas To compile the Got client tool suite on OpenBSD, run:
25 7cc94e29 2018-09-08 stsp $ make install
27 53ccebc2 2019-07-30 stsp This will install the following commands:
29 53ccebc2 2019-07-30 stsp got, the command line interface
30 53ccebc2 2019-07-30 stsp tog, an ncurses-based interactive Git repository browser
31 53ccebc2 2019-07-30 stsp several helper programs from the libexec directory
32 53ccebc2 2019-07-30 stsp man pages (only installed if building sources from a Got release tarball)
34 0e673013 2019-01-02 stsp Tests will pass only after 'make install' because they rely on installed
35 ffa5bcf7 2023-04-14 thomas binaries in $PATH. Any tests written as shell scripts also depend on git(1).
36 34c3415f 2021-09-21 stsp Tests which use the got clone, fetch, and send commands will fail if
37 34c3415f 2021-09-21 stsp 'ssh 127.0.0.1' does not succeed non-interactively.
39 c4096499 2019-01-02 stsp $ doas pkg_add git
40 7cc94e29 2018-09-08 stsp $ make regress
42 b32c4525 2020-01-05 stsp To test with packed repositories, run:
44 b32c4525 2020-01-05 stsp $ make regress GOT_TEST_PACK=1
46 9581acf4 2023-02-17 thomas To test with packed repositories using the ref-delta representation for
47 9581acf4 2023-02-17 thomas deltified objects, run:
49 9581acf4 2023-02-17 thomas $ make regress GOT_TEST_PACK=ref-delta
51 11f4fa81 2020-10-01 stsp Because got unveils the /tmp directory by default using the /tmp directory
52 11f4fa81 2020-10-01 stsp for test data can hide bugs. However, /tmp remains the default because
53 11f4fa81 2020-10-01 stsp there is no better alternative that works out of the box. In order to
54 11f4fa81 2020-10-01 stsp store test data in a directory other than /tmp, such as ~/got-test, run:
56 11f4fa81 2020-10-01 stsp $ mkdir ~/got-test
57 11f4fa81 2020-10-01 stsp $ make regress GOT_TEST_ROOT=~/got-test
59 59d2cb90 2023-04-22 thomas The tog automated test suite is also run with 'make regress'.
60 59d2cb90 2023-04-22 thomas Like Got, however, individual tests or the entire suite can be run:
62 b85a3496 2023-04-14 thomas $ cd regress/tog
63 b85a3496 2023-04-14 thomas $ make # run all tests
64 b85a3496 2023-04-14 thomas $ ./log.sh # run log view tests
66 53ccebc2 2019-07-30 stsp Man page files in the Got source tree can be viewed with 'man -l':
68 107f9ed5 2019-07-27 klemens $ man -l got/got.1
69 107f9ed5 2019-07-27 klemens $ man -l got/git-repository.5
70 107f9ed5 2019-07-27 klemens $ man -l got/got-worktree.5
71 107f9ed5 2019-07-27 klemens $ man -l tog/tog.1
73 e1fa9f20 2019-07-14 stsp EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
76 3efd8e31 2022-10-23 thomas To compile the Got server tool suite on OpenBSD, run:
78 3efd8e31 2022-10-23 thomas $ make obj
79 3efd8e31 2022-10-23 thomas $ make server
80 3efd8e31 2022-10-23 thomas $ make server-install
82 3efd8e31 2022-10-23 thomas This will install the following commands:
84 3efd8e31 2022-10-23 thomas gotd, the repository server program
85 c902213d 2022-10-29 thomas gotctl, the server control utility
86 3efd8e31 2022-10-23 thomas gotsh, the login shell for users accessing the server via the network
87 5dcb3a43 2023-04-01 thomas gitwrapper, like mailwrapper(8) but for git-upload-pack and git-receive-pack
89 3efd8e31 2022-10-23 thomas See the following manual page files for information about server setup:
91 3efd8e31 2022-10-23 thomas $ man -l gotd/gotd.8
92 3efd8e31 2022-10-23 thomas $ man -l gotd/gotd.conf.5
93 c902213d 2022-10-29 thomas $ man -l gotctl/gotctl.8
94 3efd8e31 2022-10-23 thomas $ man -l gotsh/gotsh.1
95 5dcb3a43 2023-04-01 thomas $ man -l gitwrapper/gitwrapper.1
97 f2900386 2022-10-31 thomas See regress/gotd/README for information about running the server test suite.
100 2e4e6f2c 2023-01-02 thomas Game of Trees Web Daemon (gotwebd) is a FastCGI program which displays
101 2e4e6f2c 2023-01-02 thomas repository data and is designed to work with httpd(8).
103 85c360aa 2023-01-02 thomas To compile gotwebd on OpenBSD, run:
105 85c360aa 2023-01-02 thomas $ make webd
106 85c360aa 2023-01-02 thomas # make webd-install
108 270ebbdc 2020-01-16 stsp This will create the following files:
109 85c360aa 2023-01-02 thomas the daemon program /usr/local/sbin/gotwebd
110 85c360aa 2023-01-02 thomas css and image files in /var/www/htdocs/gotwebd
111 85c360aa 2023-01-02 thomas the gotwebd init script in /etc/rc.d
112 270ebbdc 2020-01-16 stsp man pages (only installed if building sources from a Got release tarball)
114 738b3756 2020-01-28 stsp Documentation is available in manual pages:
116 85c360aa 2023-01-02 thomas $ man -l gotwebd/gotwebd.8
117 85c360aa 2023-01-02 thomas $ man -l gotwebd/gotwebd.conf.5
120 296304f3 2021-06-18 stsp Got can be built with profiling enabled to debug performance issues.
121 296304f3 2021-06-18 stsp Note that profiled builds cannot make use of pledge(2).
122 296304f3 2021-06-18 stsp Profiling should only be enabled for one program at a time. Otherwise,
123 296304f3 2021-06-18 stsp multiple programs will attempt to write to the 'gmon.out' file in the
124 296304f3 2021-06-18 stsp current working directory.
126 296304f3 2021-06-18 stsp For example, to compile got-read-pack with profiling enabled:
128 296304f3 2021-06-18 stsp $ cd libexec/got-read-pack
129 296304f3 2021-06-18 stsp $ make clean
130 296304f3 2021-06-18 stsp $ make PROFILE=1
131 296304f3 2021-06-18 stsp $ make install
133 296304f3 2021-06-18 stsp Running any Got command which ends up using got-read-pack should now
134 296304f3 2021-06-18 stsp produce the file 'gmon.out' in the current working directory.
135 296304f3 2021-06-18 stsp The gprof2dot program can be used to generate a profile graph:
137 296304f3 2021-06-18 stsp $ doas pkg_add gprof2dot graphviz
138 296304f3 2021-06-18 stsp $ gprof ~/bin/got-read-pack gmon.out | gprof2dot | dot -T png > profile.png
141 42620da7 2019-07-14 stsp Guidelines for reporting problems:
143 42620da7 2019-07-14 stsp All problem/bug reports should include a reproduction recipe in form of a
144 42620da7 2019-07-14 stsp shell script which starts out with an empty repository and runs a series of
145 8deda1af 2019-07-14 stsp Got and/or Git commands to trigger the problem, be it a crash or some other
146 42620da7 2019-07-14 stsp undesirable behaviour.
148 42620da7 2019-07-14 stsp The regress/cmdline directory contains plenty of example scripts.
149 42620da7 2019-07-14 stsp An ideal reproduction recipe is written as an xfail ("expected failure")
150 42620da7 2019-07-14 stsp regression test. For a real-world example of an xfail test, see commits
151 42620da7 2019-07-14 stsp 4866d0842a2b34812818685aaa31d3e0a966412d and
152 8deda1af 2019-07-14 stsp 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
154 42620da7 2019-07-14 stsp Please take this request very seriously; Ask for help with writing your
155 42620da7 2019-07-14 stsp regression test before asking for your problem to be fixed. Time invested
156 42620da7 2019-07-14 stsp in writing a regression test saves time wasted on back-and-forth discussion
157 42620da7 2019-07-14 stsp about how the problem can be reproduced. A regression test will need to be
158 42620da7 2019-07-14 stsp written in any case to verify a fix and prevent the problem from resurfacing.
160 9532f6b4 2019-07-14 stsp It is also possible to write test cases in C. Various examples of this
161 7d405766 2019-07-30 stsp exist in the regress/ directory. Most such tests are unit tests; it is
162 7d405766 2019-07-30 stsp unlikely that a problem found during regular usage will require a test
163 7d405766 2019-07-30 stsp to be written in C.
165 56f95bee 2019-07-14 stsp Please always try to find a way to trigger your problem via the command line
166 56f95bee 2019-07-14 stsp interface before reporting a problem without a written test case included.
167 56f95bee 2019-07-14 stsp If writing an automated test really turns out to be impossible, please
168 56f95bee 2019-07-14 stsp explain in very clear terms how the problem can be reproduced.
170 3ba86cef 2019-09-25 stsp Mail problem reports to: gameoftrees@openbsd.org
173 42620da7 2019-07-14 stsp Guidelines for submitting patches:
175 3ba86cef 2019-09-25 stsp Mail patches to: gameoftrees@openbsd.org
176 52be27fc 2019-07-30 stsp Pull requests via any Git hosting sites will likely be overlooked.
177 52be27fc 2019-07-30 stsp Please keep the intended target audience in mind when contributing to Got.
180 3ba86cef 2019-09-25 stsp Subscribing to the gameoftrees@openbsd.org mailing list:
182 3ba86cef 2019-09-25 stsp The mailing list is used for patch reviews, bug reports, and user questions.
183 3ba86cef 2019-09-25 stsp To subscribe, send mail to majordomo@openbsd.org with a message body of:
184 3ba86cef 2019-09-25 stsp subscribe gameoftrees
186 3ba86cef 2019-09-25 stsp See https://www.openbsd.org/mail.html for more information.
