public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
* [GSoC][Patch] Does it have developer documentation?
@ 2025-03-02 10:34 li li
  2025-03-02 16:16 ` Lucas Seiki Oshiro
  0 siblings, 1 reply; 2+ messages in thread
From: li li @ 2025-03-02 10:34 UTC (permalink / raw)
  To: git@vger.kernel.org



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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [GSoC][Patch] Does it have developer documentation?
  2025-03-02 10:34 [GSoC][Patch] Does it have developer documentation? li li
@ 2025-03-02 16:16 ` Lucas Seiki Oshiro
  0 siblings, 0 replies; 2+ messages in thread
From: Lucas Seiki Oshiro @ 2025-03-02 16:16 UTC (permalink / raw)
  To: li li; +Cc: git@vger.kernel.org


> 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!

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-03-02 16:16 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-03-02 10:34 [GSoC][Patch] Does it have developer documentation? li li
2025-03-02 16:16 ` Lucas Seiki Oshiro

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox