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 66164023 2019-08-09 stsp Got is still under development; it is being developed exclusively
5 66164023 2019-08-09 stsp on OpenBSD and its target audience are OpenBSD developers. Got is
6 66164023 2019-08-09 stsp ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
8 66164023 2019-08-09 stsp Got uses Git repositories to store versioned data. At present, Got
9 66164023 2019-08-09 stsp supports local version control operations only. Git can be used
10 66164023 2019-08-09 stsp for any functionality which has not yet been implemented in Got.
11 66164023 2019-08-09 stsp It will always remain possible to work with both Got and Git on
12 66164023 2019-08-09 stsp the same repository.
14 7cc94e29 2018-09-08 stsp To compile the Got tool suite on OpenBSD, run:
18 7cc94e29 2018-09-08 stsp $ make install
20 53ccebc2 2019-07-30 stsp This will install the following commands:
22 53ccebc2 2019-07-30 stsp got, the command line interface
23 53ccebc2 2019-07-30 stsp tog, an ncurses-based interactive Git repository browser
24 53ccebc2 2019-07-30 stsp several helper programs from the libexec directory
25 53ccebc2 2019-07-30 stsp man pages (only installed if building sources from a Got release tarball)
27 53ccebc2 2019-07-30 stsp A Got release tarball will install files under /usr/local by default.
28 53ccebc2 2019-07-30 stsp A build started in Got's Git repository will install files under ~/bin.
30 0e673013 2019-01-02 stsp Tests will pass only after 'make install' because they rely on installed
31 c4096499 2019-01-02 stsp binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
33 c4096499 2019-01-02 stsp $ doas pkg_add git
34 7cc94e29 2018-09-08 stsp $ make regress
36 53ccebc2 2019-07-30 stsp Man page files in the Got source tree can be viewed with 'man -l':
38 107f9ed5 2019-07-27 klemens $ man -l got/got.1
39 107f9ed5 2019-07-27 klemens $ man -l got/git-repository.5
40 107f9ed5 2019-07-27 klemens $ man -l got/got-worktree.5
41 107f9ed5 2019-07-27 klemens $ man -l tog/tog.1
43 e1fa9f20 2019-07-14 stsp EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
46 42620da7 2019-07-14 stsp Guidelines for reporting problems:
48 42620da7 2019-07-14 stsp All problem/bug reports should include a reproduction recipe in form of a
49 42620da7 2019-07-14 stsp shell script which starts out with an empty repository and runs a series of
50 8deda1af 2019-07-14 stsp Got and/or Git commands to trigger the problem, be it a crash or some other
51 42620da7 2019-07-14 stsp undesirable behaviour.
53 42620da7 2019-07-14 stsp The regress/cmdline directory contains plenty of example scripts.
54 42620da7 2019-07-14 stsp An ideal reproduction recipe is written as an xfail ("expected failure")
55 42620da7 2019-07-14 stsp regression test. For a real-world example of an xfail test, see commits
56 42620da7 2019-07-14 stsp 4866d0842a2b34812818685aaa31d3e0a966412d and
57 8deda1af 2019-07-14 stsp 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
59 42620da7 2019-07-14 stsp Please take this request very seriously; Ask for help with writing your
60 42620da7 2019-07-14 stsp regression test before asking for your problem to be fixed. Time invested
61 42620da7 2019-07-14 stsp in writing a regression test saves time wasted on back-and-forth discussion
62 42620da7 2019-07-14 stsp about how the problem can be reproduced. A regression test will need to be
63 42620da7 2019-07-14 stsp written in any case to verify a fix and prevent the problem from resurfacing.
65 9532f6b4 2019-07-14 stsp It is also possible to write test cases in C. Various examples of this
66 7d405766 2019-07-30 stsp exist in the regress/ directory. Most such tests are unit tests; it is
67 7d405766 2019-07-30 stsp unlikely that a problem found during regular usage will require a test
68 7d405766 2019-07-30 stsp to be written in C.
70 42620da7 2019-07-14 stsp Some areas of code, such as the tog UI, are not covered by automated tests.
71 56f95bee 2019-07-14 stsp Please always try to find a way to trigger your problem via the command line
72 56f95bee 2019-07-14 stsp interface before reporting a problem without a written test case included.
73 56f95bee 2019-07-14 stsp If writing an automated test really turns out to be impossible, please
74 56f95bee 2019-07-14 stsp explain in very clear terms how the problem can be reproduced.
76 42620da7 2019-07-14 stsp Mail problem reports to: Stefan Sperling <stsp@stsp.name>
79 42620da7 2019-07-14 stsp Guidelines for submitting patches:
81 42620da7 2019-07-14 stsp Mail patches to: Stefan Sperling <stsp@stsp.name>
82 52be27fc 2019-07-30 stsp Pull requests via any Git hosting sites will likely be overlooked.
83 52be27fc 2019-07-30 stsp Please keep the intended target audience in mind when contributing to Got.
