libgit-thin: Instalation support
[git/libgit-gsoc.git] / libgit-thin / TODO
blob4be29f87f67b1f53ad3eacdab7695017705aef49
1 General
2 -------
4 o Install target (ie, 'make install) is not very good, it copies git's
5   files for instance
6 o Better integrate with the toplevel Makefile, so there's less duplication
7   and more of the toplevel's configuration (like guessing GIT_LIBS) can be
8   inherited
10 Documentation
11 -------------
13 o Currently, libgit-thin's generated documentation is very low-level. We're
14   showing which files we have and their includes. Instead, we should only
15   show a function listing sorted by subject (eg, commit, rev listing etc).
16 o Into each subject, functions should be sorted too (eg, __git_commit_free()
17   right before git_commit_free()). Currently they're sorted in alphabetical
18   order
20 pygit
21 -----
23 o Test-suite
24 o Implement missing commit date functions
25 o Not sure whether PyGitError is the right thing to do
26 o Some revlist options could be attributes, not methods (eg, show_merges
27   and max_count)
28 o Pygit types should be useful as base classes
29 o Commit type's compare is wrong currently
30 o Integrate the build in the main one
32 tests
33 -----
35 o See tests/MISSING-TESTS for missing tests to write
36 o When the test-suite fails, we do not remove the git repo created
37   for the test in the /tmp/ dir
38 o Some tests still have hardcoded data
39 o Currently ltcommit-suite uses ltrevlist functions but it shouldn't,
40   because a function can only be used after it's tested. The better to
41   to do here is to change ltcommit-suite to use a hardcoded commit
42   buffer instead of relying on ltrevlist's functions
43 o ltrevlist-suite is bad written, its tests are big and doesn't
44   follow the rule of first testing a function before using it.
45   Refactoring is required here.
46 o Test coverage is a cool idea (see libcheck's manual)
48 ltcommit
49 --------
51 o git_commit_parent() is missing
52 o A lot of functions can share common code (eg, _date()s)
54 ltrevlist
55 ---------
57 o Implement missing revlist options