From 40f02a9b3868c389598a5fe407a718eb6295ff02 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 5 Jan 2015 17:03:44 -0400 Subject: comment --- ...omment_48_9c08300c5d172ba9223042a00c8acb2b._comment | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/install/fromsource/comment_48_9c08300c5d172ba9223042a00c8acb2b._comment diff --git a/doc/install/fromsource/comment_48_9c08300c5d172ba9223042a00c8acb2b._comment b/doc/install/fromsource/comment_48_9c08300c5d172ba9223042a00c8acb2b._comment new file mode 100644 index 000000000..4e58da1bb --- /dev/null +++ b/doc/install/fromsource/comment_48_9c08300c5d172ba9223042a00c8acb2b._comment @@ -0,0 +1,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. +"""]] -- cgit v1.2.3