From: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
To: li li <li0371859@gmail.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: [GSoC][Patch] Does it have developer documentation?
Date: Sun, 2 Mar 2025 13:16:26 -0300 [thread overview]
Message-ID: <C748EB41-1F8A-4B67-B809-623D4104F78A@gmail.com> (raw)
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!
prev parent reply other threads:[~2025-03-02 16:16 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-02 10:34 [GSoC][Patch] Does it have developer documentation? li li
2025-03-02 16:16 ` Lucas Seiki Oshiro [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=C748EB41-1F8A-4B67-B809-623D4104F78A@gmail.com \
--to=lucasseikioshiro@gmail.com \
--cc=git@vger.kernel.org \
--cc=li0371859@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox