[NTLK] ROM Disassembly online?

[Steven Frank]

Unless you need specific functionality beyond just inserting, removing, or moving lines of text, this sounds kind of like a traditional diff & patch situation, assuming everyone was starting from the same base file.

You'd start with your raw disassembly as the base, add comments, and then generate a diff to get just the comments.  Put that diff on GitHub.

Next person generates their own disassembly, applies current diff, adds their comments, generates a new diff, then... appends that to the one on GitHub?  Would that work?

Steven 


> On Apr 1, 2015, at 8:46 PM, Matthias Melcher <mm at matthiasm.com> wrote:
> 
> OK, let's say that the disassembler spews this out:
> 
> [snip]
> Next, any one in the group decides that this is important and adds comments (mine start with @@ or @@@):
> 
> 
> @@@ \brief Initialize the idle timer
> @@@ Actually, the real timer is a derived class, so there is no code needed here
> @@@ \param a  whatever
> @@@ \param b  I don't know
> @@@ \return nothing at all
> [snip]
> 
> Now, we probably should not put the entire code online, but instead just a file containing comments. The comments must be extracted automatically, and re-merged automatically as well. For example, removing the assembler code would give something like:
> 
> 
> 0x00025464.pre    @@@ \brief Initialize the idle timer
> 0x00025464.pre    @@@ Actually, the real timer is a derived class, so there is no code needed here
> 0x00025464.pre    @@@ \param a  whatever
> 0x00025464.pre    @@@ \param b  I don't know
> 0x00025464.pre    @@@ \return nothing at all
> 0x00025464.post+2 @@ actually, the disassembler is wrong: R0 is 'this'
> 0x00025464.pre    @@ the following line simply returns without a return value
> 
> 
> So no information with copyright is ever posted to Github. The important part would be to centralize all comments of everyone who read the code. So we don't do it over and over again.