summaryrefslogtreecommitdiff
path: root/doc/install/fromsource/comment_48_9c08300c5d172ba9223042a00c8acb2b._comment
blob: 4e58da1bb463e0c7af0d08c6a49dfec62eda3c2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[[!comment format=mdwn
 username="joey"
 subject="""where to start reading the source code"""
 date="2015-01-05T20:58:50Z"
 content="""
@thnetos, great question!

Annex.hs is a key starting place, as it defines git-annex's main monad.
If you like learning code bases bottom-up, Types/* has files for
the main data types used in git-annex, such as Key and UUID and Remote and
GitConfig.

Command/* gets you the implementation of any particular git-annex command
you are interested in. Or Remote/* for any particular special remote.

I recommend running "make tags" and then your editor should be able to use
the tags file to bounce around in the source code.
"""]]