{"thread":{"id":"63040","subject":"[GSoC][Patch] Does it have developer documentation?","startedAt":"2025-03-02T10:35:02Z","lastAt":"2025-03-02T16:16:41Z","messageCount":2,"participants":["li li","Lucas Seiki Oshiro"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"513362","messageId":"SEZPR01MB5486585EF47B99A59C7E9F4DA3CE2@SEZPR01MB5486.apcprd01.prod.exchangelabs.com","threadId":"63040","inReplyTo":null,"subject":"[GSoC][Patch] Does it have developer documentation?","fromName":"li li","fromEmail":"li0371859@gmail.com","sentAt":"2025-03-02T10:34:56Z","receivedAt":"2025-03-02T10:35:02Z","isPatch":true,"sender":{"key":"li0371859@gmail.com","avatar":null},"body":"\n\nDoes git have developer documentation like haiku os, where you can quickly read the source code and know what this part or this function does.\n\nI didn't find it at https://git-scm.com/.\n\nThis is too painful"},{"id":"513368","messageId":"C748EB41-1F8A-4B67-B809-623D4104F78A@gmail.com","threadId":"63040","inReplyTo":"SEZPR01MB5486585EF47B99A59C7E9F4DA3CE2@SEZPR01MB5486.apcprd01.prod.exchangelabs.com","subject":"Re: [GSoC][Patch] Does it have developer documentation?","fromName":"Lucas Seiki Oshiro","fromEmail":"lucasseikioshiro@gmail.com","sentAt":"2025-03-02T16:16:26Z","receivedAt":"2025-03-02T16:16:41Z","isPatch":true,"sender":{"key":"lucasseikioshiro@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12701580?v=4"},"body":"\n> 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.\n\nGit's Git history is very descriptive and the commits\nare themselves a good documentation. If the function\ndescription is not enough, you can inspect the\ncommits related to that function/piece of code using\ngit blame or git log.\n\nFor example, I randomly picked the function\n`handle_path_include` from `config.c`. We can check the\nhistory of that function using:\n\n`git log -L :handle_path_include:config.c`\n\nI described more this kind of search here:\nhttps://lucasoshiro.github.io/posts-en/2023-02-13-git-debug/\n\nI hope that it helps you!"}]}