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