1 c75df689 2019-07-14 stsp Game of Trees (Got) is a version control system which prioritizes ease
2 c75df689 2019-07-14 stsp of use and simplicity over flexibility.
4 dd2a8a69 2019-07-14 stsp Got is being developed exclusively on OpenBSD. It is not a drop-in
5 dd2a8a69 2019-07-14 stsp replacement for other version control systems and it does not attempt
6 010a287c 2019-07-14 stsp to compete with anything else than the use of other version control
7 dd2a8a69 2019-07-14 stsp systems in the context of the OpenBSD project.
8 dd2a8a69 2019-07-14 stsp Got's target audience are OpenBSD developers, and its focus is directed
9 dd2a8a69 2019-07-14 stsp at the particular needs and use cases of the OpenBSD project.
11 7cc94e29 2018-09-08 stsp To compile the Got tool suite on OpenBSD, run:
15 7cc94e29 2018-09-08 stsp $ make install
17 53ccebc2 2019-07-30 stsp This will install the following commands:
19 53ccebc2 2019-07-30 stsp got, the command line interface
20 53ccebc2 2019-07-30 stsp tog, an ncurses-based interactive Git repository browser
21 53ccebc2 2019-07-30 stsp several helper programs from the libexec directory
22 53ccebc2 2019-07-30 stsp man pages (only installed if building sources from a Got release tarball)
24 53ccebc2 2019-07-30 stsp A Got release tarball will install files under /usr/local by default.
25 53ccebc2 2019-07-30 stsp A build started in Got's Git repository will install files under ~/bin.
27 0e673013 2019-01-02 stsp Tests will pass only after 'make install' because they rely on installed
28 c4096499 2019-01-02 stsp binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
30 c4096499 2019-01-02 stsp $ doas pkg_add git
31 7cc94e29 2018-09-08 stsp $ make regress
33 53ccebc2 2019-07-30 stsp Man page files in the Got source tree can be viewed with 'man -l':
35 107f9ed5 2019-07-27 klemens $ man -l got/got.1
36 107f9ed5 2019-07-27 klemens $ man -l got/git-repository.5
37 107f9ed5 2019-07-27 klemens $ man -l got/got-worktree.5
38 107f9ed5 2019-07-27 klemens $ man -l tog/tog.1
40 e1fa9f20 2019-07-14 stsp EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
43 42620da7 2019-07-14 stsp Guidelines for reporting problems:
45 42620da7 2019-07-14 stsp All problem/bug reports should include a reproduction recipe in form of a
46 42620da7 2019-07-14 stsp shell script which starts out with an empty repository and runs a series of
47 8deda1af 2019-07-14 stsp Got and/or Git commands to trigger the problem, be it a crash or some other
48 42620da7 2019-07-14 stsp undesirable behaviour.
50 42620da7 2019-07-14 stsp The regress/cmdline directory contains plenty of example scripts.
51 42620da7 2019-07-14 stsp An ideal reproduction recipe is written as an xfail ("expected failure")
52 42620da7 2019-07-14 stsp regression test. For a real-world example of an xfail test, see commits
53 42620da7 2019-07-14 stsp 4866d0842a2b34812818685aaa31d3e0a966412d and
54 8deda1af 2019-07-14 stsp 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
56 42620da7 2019-07-14 stsp Please take this request very seriously; Ask for help with writing your
57 42620da7 2019-07-14 stsp regression test before asking for your problem to be fixed. Time invested
58 42620da7 2019-07-14 stsp in writing a regression test saves time wasted on back-and-forth discussion
59 42620da7 2019-07-14 stsp about how the problem can be reproduced. A regression test will need to be
60 42620da7 2019-07-14 stsp written in any case to verify a fix and prevent the problem from resurfacing.
62 9532f6b4 2019-07-14 stsp It is also possible to write test cases in C. Various examples of this
63 7d405766 2019-07-30 stsp exist in the regress/ directory. Most such tests are unit tests; it is
64 7d405766 2019-07-30 stsp unlikely that a problem found during regular usage will require a test
65 7d405766 2019-07-30 stsp to be written in C.
67 42620da7 2019-07-14 stsp Some areas of code, such as the tog UI, are not covered by automated tests.
68 56f95bee 2019-07-14 stsp Please always try to find a way to trigger your problem via the command line
69 56f95bee 2019-07-14 stsp interface before reporting a problem without a written test case included.
70 56f95bee 2019-07-14 stsp If writing an automated test really turns out to be impossible, please
71 56f95bee 2019-07-14 stsp explain in very clear terms how the problem can be reproduced.
73 42620da7 2019-07-14 stsp Mail problem reports to: Stefan Sperling <stsp@stsp.name>
76 42620da7 2019-07-14 stsp Guidelines for submitting patches:
78 42620da7 2019-07-14 stsp Mail patches to: Stefan Sperling <stsp@stsp.name>
79 52be27fc 2019-07-30 stsp Pull requests via any Git hosting sites will likely be overlooked.
80 52be27fc 2019-07-30 stsp Please keep the intended target audience in mind when contributing to Got.
