README

   1 Game of Trees (Got) is a version control system which prioritizes ease
   2 of use and simplicity over flexibility (https://gameoftrees.org)
   3
   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.
   7
   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
  11 the same repository.
  12
  13 A Got release tarball will install files under /usr/local by default.
  14 This default can be changed by passing PREFIX=/some/path to make.
  15
  16 A build started in Got's Git repository will install files under ~/bin,
  17 which may have to be added to $PATH and be created first:
  18
  19  $ mkdir ~/bin
  20
  21 To compile the Got client tool suite on OpenBSD, run:
  22
  23  $ make obj
  24  $ make
  25  $ make install
  26
  27 This will install the following commands:
  28
  29  got, the command line interface
  30  tog, an ncurses-based interactive Git repository browser
  31  several helper programs from the libexec directory
  32  man pages (only installed if building sources from a Got release tarball)
  33
  34 Tests will pass only after 'make install' because they rely on installed
  35 binaries in $PATH. Any tests written as shell scripts also depend on git(1).
  36 Tests which use the got clone, fetch, and send commands will fail if
  37 'ssh 127.0.0.1' does not succeed non-interactively.
  38
  39 Tests for HTTP protocol support rely on the HTTP::Daemon Perl module.
  40
  41  $ doas pkg_add git p5-http-daemon
  42  $ make regress
  43
  44 To test with packed repositories, run:
  45
  46  $ make regress GOT_TEST_PACK=1
  47
  48 To test with packed repositories using the ref-delta representation for
  49 deltified objects, run:
  50
  51  $ make regress GOT_TEST_PACK=ref-delta
  52
  53 To test with sha256 object IDs instead of sha1, run:
  54
  55  $ make regress GOT_TEST_ALGO=sha256
  56
  57 The GOT_TEST_PACK and GOT_TEST_ALGO flags can be combined to test packed
  58 repositories with sha256 object IDs.
  59
  60 Because got unveils the /tmp directory by default using the /tmp directory
  61 for test data can hide bugs. However, /tmp remains the default because
  62 there is no better alternative that works out of the box. In order to
  63 store test data in a directory other than /tmp, such as ~/got-test, run:
  64
  65  $ mkdir ~/got-test
  66  $ make regress GOT_TEST_ROOT=~/got-test
  67
  68 The tog automated test suite is also run with 'make regress'.
  69 Like Got, however, individual tests or the entire suite can be run:
  70
  71  $ cd regress/tog
  72  $ make         # run all tests
  73  $ ./log.sh     # run log view tests
  74
  75 Man page files in the Got source tree can be viewed with 'man -l':
  76
  77  $ man -l got/got.1
  78  $ man -l got/git-repository.5
  79  $ man -l got/got-worktree.5
  80  $ man -l tog/tog.1
  81
  82 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
  83
  84
  85 To compile the Got server tool suite on OpenBSD, run:
  86
  87  $ make obj
  88  $ make server
  89  $ make server-install
  90
  91 This will install the following commands:
  92
  93  gotd, the repository server program
  94  gotctl, the server control utility
  95  gotsh, the login shell for users accessing the server via the network
  96  gitwrapper, like mailwrapper(8) but for git-upload-pack and git-receive-pack
  97
  98 See the following manual page files for information about server setup:
  99
 100  $ man -l gotd/gotd.8
 101  $ man -l gotd/gotd.conf.5
 102  $ man -l gotctl/gotctl.8
 103  $ man -l gotsh/gotsh.1
 104  $ man -l gitwrapper/gitwrapper.1
 105
 106 See regress/gotd/README for information about running the server test suite.
 107
 108
 109 Game of Trees Web Daemon (gotwebd) is a FastCGI program which displays
 110 repository data and is designed to work with httpd(8).
 111
 112 To compile gotwebd on OpenBSD, run:
 113
 114  $ make webd
 115  # make webd-install
 116
 117 This will create the following files:
 118   the daemon program /usr/local/sbin/gotwebd
 119   css and image files in /var/www/htdocs/gotwebd
 120   the gotwebd init script in /etc/rc.d
 121   man pages (only installed if building sources from a Got release tarball)
 122
 123 Documentation is available in manual pages:
 124
 125  $ man -l gotwebd/gotwebd.8
 126  $ man -l gotwebd/gotwebd.conf.5
 127
 128
 129 Got can be built with profiling enabled to debug performance issues.
 130 Note that profiled builds cannot make use of pledge(2).
 131 Profiling should only be enabled for one program at a time. Otherwise,
 132 multiple programs will attempt to write to the 'gmon.out' file in the
 133 current working directory.
 134
 135 For example, to compile got-read-pack with profiling enabled:
 136
 137   $ cd libexec/got-read-pack
 138   $ make clean
 139   $ make PROFILE=1
 140   $ make install
 141
 142 Running any Got command which ends up using got-read-pack should now
 143 produce the file 'gmon.out' in the current working directory.
 144 The gprof2dot program can be used to generate a profile graph:
 145
 146   $ doas pkg_add gprof2dot graphviz
 147   $ gprof ~/bin/got-read-pack gmon.out | gprof2dot | dot -T png > profile.png
 148
 149
 150 Guidelines for reporting problems:
 151
 152 All problem/bug reports should include a reproduction recipe in form of a
 153 shell script which starts out with an empty repository and runs a series of
 154 Got and/or Git commands to trigger the problem, be it a crash or some other
 155 undesirable behaviour.
 156
 157 The regress/cmdline directory contains plenty of example scripts.
 158 An ideal reproduction recipe is written as an xfail ("expected failure")
 159 regression test. For a real-world example of an xfail test, see commits
 160 4866d0842a2b34812818685aaa31d3e0a966412d and
 161 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
 162
 163 Please take this request very seriously; Ask for help with writing your
 164 regression test before asking for your problem to be fixed. Time invested
 165 in writing a regression test saves time wasted on back-and-forth discussion
 166 about how the problem can be reproduced. A regression test will need to be
 167 written in any case to verify a fix and prevent the problem from resurfacing.
 168
 169 It is also possible to write test cases in C. Various examples of this
 170 exist in the regress/ directory. Most such tests are unit tests; it is
 171 unlikely that a problem found during regular usage will require a test
 172 to be written in C.
 173
 174 Please always try to find a way to trigger your problem via the command line
 175 interface before reporting a problem without a written test case included.
 176 If writing an automated test really turns out to be impossible, please
 177 explain in very clear terms how the problem can be reproduced.
 178
 179 Mail problem reports to: gameoftrees@openbsd.org
 180
 181
 182 Guidelines for submitting patches:
 183
 184 Mail patches to: gameoftrees@openbsd.org
 185 Pull requests via any Git hosting sites will likely be overlooked.
 186 Please keep the intended target audience in mind when contributing to Got.
 187
 188
 189 Subscribing to the gameoftrees@openbsd.org mailing list:
 190
 191 The mailing list is used for patch reviews, bug reports, and user questions.
 192 To subscribe, send mail to majordomo@openbsd.org with a message body of:
 193 subscribe gameoftrees
 194
 195 See https://www.openbsd.org/mail.html for more information.