# [GSoC][Patch] Does it have developer documentation?

2 messages from 2025-03-02 to 2025-03-02. Participants: li li, Lucas Seiki Oshiro.
Thread: https://gitlist.dev/t/63040

## li li, 2025-03-02 10:34

Subject: [GSoC][Patch] Does it have developer documentation?
Message-ID: <SEZPR01MB5486585EF47B99A59C7E9F4DA3CE2@SEZPR01MB5486.apcprd01.prod.exchangelabs.com>
URL: https://gitlist.dev/e/SEZPR01MB5486585EF47B99A59C7E9F4DA3CE2%40SEZPR01MB5486.apcprd01.prod.exchangelabs.com

```


Does git have developer documentation like haiku os, where you can quickly read the source code and know what this part or this function does.

I didn't find it at https://git-scm.com/.

This is too painful
```

## Lucas Seiki Oshiro, 2025-03-02 16:16

Subject: Re: [GSoC][Patch] Does it have developer documentation?
Message-ID: <C748EB41-1F8A-4B67-B809-623D4104F78A@gmail.com>
URL: https://gitlist.dev/e/C748EB41-1F8A-4B67-B809-623D4104F78A%40gmail.com
In-Reply-To: <SEZPR01MB5486585EF47B99A59C7E9F4DA3CE2@SEZPR01MB5486.apcprd01.prod.exchangelabs.com>

```

> Does git have developer documentation like haiku os, where you can quickly read the source code and know what this part or this function does.

Git's Git history is very descriptive and the commits
are themselves a good documentation. If the function
description is not enough, you can inspect the
commits related to that function/piece of code using
git blame or git log.

For example, I randomly picked the function
`handle_path_include` from `config.c`. We can check the
history of that function using:

`git log -L :handle_path_include:config.c`

I described more this kind of search here:
https://lucasoshiro.github.io/posts-en/2023-02-13-git-debug/

I hope that it helps you!
```
