fix broken sentence in got.1 (was missing a word)
[got-portable.git] / TODO
blob1f7297bf2a0f12c2fbcce5fbb38a533d88f94d4e
1 got:
2 - Teach 'got merge' to merge changes into an arbitrary subdirectory
3   of the work tree. This would be nice for merging vendor branches.
4   Say you have a branch 'llvm-12' which intially contains a 12.0
5   release tree as published by the LLVM project, added to the repository
6   with a command such as 'got import -b llvm-12'. On the main branch we
7   would want to merge files from the llvm-12 branch into /usr/src/gnu/llvm
8   instead of the root directory checked out at /usr/src.
9   The next LLVM release 12.1 would later be committed onto the llvm-12
10   branch and then merged into main at /usr/src/gnu/llvm in the same way.
11 - Provide an option (-M) to 'got merge' which forces creation of a merge commit
12   even when forwarding is possible, for cases where users deem forwarding
13   undesirable.
14 - When a clone fails the HEAD symref will always point to "refs/heads/main"
15   (ie. the internal default HEAD symref of Got). Resuming a failed clone with
16   'got fetch' is supposed to work. To make this easier, if the HEAD symref
17   points to a non-existent reference it should be updated by 'got fetch'
18   to match the HEAD symref sent by the server.
19 - If invoked in a work tree, got fetch could default to fetching the work
20   tree's current branch, instead of fetching the remote repository's HEAD.
21 - 'got patch' should be able to detect an already applied patch.
22 - 'got patch' should ideally do more passes if a patch doesn't apply and
23   try fancy things (like ignoring context and whitespaces) only in later
24   passes.
25 - investigate whether it's worth for 'got patch' to memory-map the files to
26   edit.  (c.f. Plan A / Plan B in Larry' patch.)
27 - when fetching pack files got should verify that the requested branch tips
28   are present in the pack file sent by the server, before making this pack
29   file visible to readers of the repository
31 network protocol:
32 - add http(s) transport with libtls, speaking the two Git HTTP protocols
33   (both "dumb" and "smart" need to work) via got-fetch-pack, or a new helper
34   like got-fetch-http; it is fine if HTTP remains a fetch-only protocol, and
35   works only against servers which don't require authentication for fetches;
36   anything beyond this would require a full-featured HTTP client (Git uses
37   libcurl, which we cannot use as it is not in the OpenBSD base system)
39 tog:
40 - make 'tog log' respond to key presses while 'loading...' history; loading
41   can be slow for paths in a deep history if the path has not been changed
42   very often, and 'tog log' blocks far too long in this case
43 - make it possible to view the contents of tag objects
44 - verify signed tag objects
45 - make it possible to toggle the parent to diff against in merge commits
47 gotwebd:
48 - fix COMMITS page for paths that were deleted and/or re-added to the
49   repository. One way would be not to let the commit graph filter paths.
50   As an additional optimization we could keep a tailq or the object-id
51   set for everything traversed in the repo to have fast reverse-lookups.
52   (has the additional requirement to invalidate it when the reference
53   timestamp changes)
54 - run-time changes of addresses on interfaces are being ignored by gotwebd
55 - perhaps "bind interface" should be removed in favour of using only IP
56   addresses? This makes the address family selection explicit and avoids
57   having to monitor interfaces for dynamic address changes.
58 - add breadcrumbs to navigate in the directory tree
59 - add more action links, like "raw", "blame" and "commits" in the blob
60   page.
61 - add a "rawdiff" page to serve a diff as text/plain (or text/x-patch),
62   or maybe "rawcommit" that includes the commentary too.
63 - consider changing the URL scheme to avoid so many query parameters
65 gotd:
66 - ensure all error messages are propagated to clients before disconnecting,
67   there are probably still some cases where such error reporting is skipped
68 - client connection timeout handling needs to be checked by regress tests,
69   and is likely in need of improvement
70 - implement stress-tests to observe and fix misbehaviour under load
71 - listener's fd-reserve limit needs to be reviewed and perhaps adjusted
72 - implement pre-commit checks (in lieu of hook scripts):
73   1. deny branch history rewriting ('got send -f') via gotd.conf [done]
74   2. allow/deny creation/deletion of references via gotd.conf
75   3. deny modifications within a given reference namespace via gotd.conf [done]
76   4. entirely hide a given reference namespace from clients via gotd.conf
77   5. allow/deny addition of binary files to a repo via gotd.conf
78   6. enforce a particular blob size limit via gotd.conf
79   7. optionally reject merge commits via gotd.conf
80 - implement post-commit-event libexec handlers (in lieu of hook scripts):
81   1. commit email notification, plaintext smtp to localhost port 25
82   2. general-purpose HTTP(s) GET/POST request as commit notification,
83      should use a format string to encode commit-info in the request URL
84   3. perform the equivalent of 'got send' to another repository
85 - keep track of available repository disk space and fail gracefully when
86   uploaded pack files would fill up the disk too much, keeping a reserve
87 - reuse packed non-delta objects directly (without re-deltification) for speed
88 - if no permit statement is given in gotd.conf it is possible to send a branch
89   into an empty repository regardless; this should return EPERM instead
91 gotadmin:
92 - add support for generating git-fast-export streams from a repository
93 - add support for importing git-fast-export streams into a repository
94 - speed up 'gotadmin pack -a' is too slow on repositories with many pack files