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