Page 1 of 1

Generated overview of PCM Hammer code

Posted: Sat Apr 26, 2025 3:24 pm
by NSFW
This was generated by an LLM, so don't trust it entirely...
But I've been browsing it for a few minutes and haven't noticed any major problems.

https://deepwiki.com/PcmHammer/PcmHammer

The section about the logger is kinda confusing, but then again the logging code is kinda confusing too. :)
The sequence diagram of the flash process would be better off without the "Protocol Class" column, but it's pretty good otherwise.

You can make it generate docs for any project by going to deepwiki.com/<accountname>/<reponame>

Gonna try it on the the AllPro code next...
https://deepwiki.com/antuspcm/allpro

Re: Onerated overview of PCM Hammer code

Posted: Sat Apr 26, 2025 3:29 pm
by antus
Wow that is absolutely amazing. It makes me feel good about the internal organization of the code. Those flow summaries that talk about capabilities, chip types, kernels, dependencies etc are really helpful. The source code must be reasonably tidy after all. The part which talks about the devices and the inheritance is useful as well. I'll probably start using that myself too keep my head around what is where in the program, especially if we attempt to convert the communications to a state machine to make the whole system more tolerant of modules communicating when they are not expected to during a reflash on a car.