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