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 66164023 2019-08-09 stsp Got uses Git repositories to store versioned data. At present, Got
9 66164023 2019-08-09 stsp supports local version control operations only. Git can be used
10 66164023 2019-08-09 stsp for any functionality which has not yet been implemented in Got.
11 66164023 2019-08-09 stsp It will always remain possible to work with both Got and Git on
12 66164023 2019-08-09 stsp the same repository.
14 13b2bc37 2022-10-23 stsp To compile the Got client tool suite on OpenBSD, run:
18 7cc94e29 2018-09-08 stsp $ make install
20 53ccebc2 2019-07-30 stsp This will install the following commands:
22 53ccebc2 2019-07-30 stsp got, the command line interface
23 53ccebc2 2019-07-30 stsp tog, an ncurses-based interactive Git repository browser
24 53ccebc2 2019-07-30 stsp several helper programs from the libexec directory
25 53ccebc2 2019-07-30 stsp man pages (only installed if building sources from a Got release tarball)
27 53ccebc2 2019-07-30 stsp A Got release tarball will install files under /usr/local by default.
28 53ccebc2 2019-07-30 stsp A build started in Got's Git repository will install files under ~/bin.
30 0e673013 2019-01-02 stsp Tests will pass only after 'make install' because they rely on installed
31 c4096499 2019-01-02 stsp binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
32 34c3415f 2021-09-21 stsp Tests which use the got clone, fetch, and send commands will fail if
33 34c3415f 2021-09-21 stsp 'ssh 127.0.0.1' does not succeed non-interactively.
35 c4096499 2019-01-02 stsp $ doas pkg_add git
36 7cc94e29 2018-09-08 stsp $ make regress
38 b32c4525 2020-01-05 stsp To test with packed repositories, run:
40 b32c4525 2020-01-05 stsp $ make regress GOT_TEST_PACK=1
42 11f4fa81 2020-10-01 stsp Because got unveils the /tmp directory by default using the /tmp directory
43 11f4fa81 2020-10-01 stsp for test data can hide bugs. However, /tmp remains the default because
44 11f4fa81 2020-10-01 stsp there is no better alternative that works out of the box. In order to
45 11f4fa81 2020-10-01 stsp store test data in a directory other than /tmp, such as ~/got-test, run:
47 11f4fa81 2020-10-01 stsp $ mkdir ~/got-test
48 11f4fa81 2020-10-01 stsp $ make regress GOT_TEST_ROOT=~/got-test
50 53ccebc2 2019-07-30 stsp Man page files in the Got source tree can be viewed with 'man -l':
52 107f9ed5 2019-07-27 klemens $ man -l got/got.1
53 107f9ed5 2019-07-27 klemens $ man -l got/git-repository.5
54 107f9ed5 2019-07-27 klemens $ man -l got/got-worktree.5
55 107f9ed5 2019-07-27 klemens $ man -l tog/tog.1
57 e1fa9f20 2019-07-14 stsp EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
60 13b2bc37 2022-10-23 stsp To compile the Got server tool suite on OpenBSD, run:
63 13b2bc37 2022-10-23 stsp $ make server
64 13b2bc37 2022-10-23 stsp $ make server-install
66 13b2bc37 2022-10-23 stsp This will install the following commands:
68 13b2bc37 2022-10-23 stsp gotd, the repository server program
69 f1752522 2022-10-29 stsp gotctl, the server control utility
70 13b2bc37 2022-10-23 stsp gotsh, the login shell for users accessing the server via the network
72 13b2bc37 2022-10-23 stsp See the following manual page files for information about server setup:
74 13b2bc37 2022-10-23 stsp $ man -l gotd/gotd.8
75 13b2bc37 2022-10-23 stsp $ man -l gotd/gotd.conf.5
76 f1752522 2022-10-29 stsp $ man -l gotctl/gotctl.8
77 13b2bc37 2022-10-23 stsp $ man -l gotsh/gotsh.1
79 6ae16afd 2022-10-31 stsp See regress/gotd/README for information about running the server test suite.
82 0d8212e7 2022-12-30 stsp Game of Trees Web Daemon (gotwebd) is a FastCGI program which displays
83 0d8212e7 2022-12-30 stsp repository data and is designed to work with httpd(8).
85 06991378 2022-12-30 tracey To compile gotwebd on OpenBSD, run:
87 06991378 2022-12-30 tracey $ make webd
88 06991378 2022-12-30 tracey # make webd-install
90 270ebbdc 2020-01-16 stsp This will create the following files:
91 06991378 2022-12-30 tracey the daemon program /usr/local/sbin/gotwebd
92 06991378 2022-12-30 tracey css and image files in /var/www/htdocs/gotwebd
93 06991378 2022-12-30 tracey the gotwebd init script in /etc/rc.d
94 270ebbdc 2020-01-16 stsp man pages (only installed if building sources from a Got release tarball)
96 738b3756 2020-01-28 stsp Documentation is available in manual pages:
98 06991378 2022-12-30 tracey $ man -l gotwebd/gotwebd.8
99 06991378 2022-12-30 tracey $ man -l gotwebd/gotwebd.conf.5
102 296304f3 2021-06-18 stsp Got can be built with profiling enabled to debug performance issues.
103 296304f3 2021-06-18 stsp Note that profiled builds cannot make use of pledge(2).
104 296304f3 2021-06-18 stsp Profiling should only be enabled for one program at a time. Otherwise,
105 296304f3 2021-06-18 stsp multiple programs will attempt to write to the 'gmon.out' file in the
106 296304f3 2021-06-18 stsp current working directory.
108 296304f3 2021-06-18 stsp For example, to compile got-read-pack with profiling enabled:
110 296304f3 2021-06-18 stsp $ cd libexec/got-read-pack
111 296304f3 2021-06-18 stsp $ make clean
112 296304f3 2021-06-18 stsp $ make PROFILE=1
113 296304f3 2021-06-18 stsp $ make install
115 296304f3 2021-06-18 stsp Running any Got command which ends up using got-read-pack should now
116 296304f3 2021-06-18 stsp produce the file 'gmon.out' in the current working directory.
117 296304f3 2021-06-18 stsp The gprof2dot program can be used to generate a profile graph:
119 296304f3 2021-06-18 stsp $ doas pkg_add gprof2dot graphviz
120 296304f3 2021-06-18 stsp $ gprof ~/bin/got-read-pack gmon.out | gprof2dot | dot -T png > profile.png
123 42620da7 2019-07-14 stsp Guidelines for reporting problems:
125 42620da7 2019-07-14 stsp All problem/bug reports should include a reproduction recipe in form of a
126 42620da7 2019-07-14 stsp shell script which starts out with an empty repository and runs a series of
127 8deda1af 2019-07-14 stsp Got and/or Git commands to trigger the problem, be it a crash or some other
128 42620da7 2019-07-14 stsp undesirable behaviour.
130 42620da7 2019-07-14 stsp The regress/cmdline directory contains plenty of example scripts.
131 42620da7 2019-07-14 stsp An ideal reproduction recipe is written as an xfail ("expected failure")
132 42620da7 2019-07-14 stsp regression test. For a real-world example of an xfail test, see commits
133 42620da7 2019-07-14 stsp 4866d0842a2b34812818685aaa31d3e0a966412d and
134 8deda1af 2019-07-14 stsp 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
136 42620da7 2019-07-14 stsp Please take this request very seriously; Ask for help with writing your
137 42620da7 2019-07-14 stsp regression test before asking for your problem to be fixed. Time invested
138 42620da7 2019-07-14 stsp in writing a regression test saves time wasted on back-and-forth discussion
139 42620da7 2019-07-14 stsp about how the problem can be reproduced. A regression test will need to be
140 42620da7 2019-07-14 stsp written in any case to verify a fix and prevent the problem from resurfacing.
142 9532f6b4 2019-07-14 stsp It is also possible to write test cases in C. Various examples of this
143 7d405766 2019-07-30 stsp exist in the regress/ directory. Most such tests are unit tests; it is
144 7d405766 2019-07-30 stsp unlikely that a problem found during regular usage will require a test
145 7d405766 2019-07-30 stsp to be written in C.
147 42620da7 2019-07-14 stsp Some areas of code, such as the tog UI, are not covered by automated tests.
148 56f95bee 2019-07-14 stsp Please always try to find a way to trigger your problem via the command line
149 56f95bee 2019-07-14 stsp interface before reporting a problem without a written test case included.
150 56f95bee 2019-07-14 stsp If writing an automated test really turns out to be impossible, please
151 56f95bee 2019-07-14 stsp explain in very clear terms how the problem can be reproduced.
153 3ba86cef 2019-09-25 stsp Mail problem reports to: gameoftrees@openbsd.org
156 42620da7 2019-07-14 stsp Guidelines for submitting patches:
158 3ba86cef 2019-09-25 stsp Mail patches to: gameoftrees@openbsd.org
159 52be27fc 2019-07-30 stsp Pull requests via any Git hosting sites will likely be overlooked.
160 52be27fc 2019-07-30 stsp Please keep the intended target audience in mind when contributing to Got.
163 3ba86cef 2019-09-25 stsp Subscribing to the gameoftrees@openbsd.org mailing list:
165 3ba86cef 2019-09-25 stsp The mailing list is used for patch reviews, bug reports, and user questions.
166 3ba86cef 2019-09-25 stsp To subscribe, send mail to majordomo@openbsd.org with a message body of:
167 3ba86cef 2019-09-25 stsp subscribe gameoftrees
169 3ba86cef 2019-09-25 stsp See https://www.openbsd.org/mail.html for more information.
