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