This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: complete command doesn't work for files...
Comments in code should not say why what is no longer in the code was incorrect... That is just confusing. So the text of the ChangeLog is not appropriate as a comment in the code.
From the change log doco:
There's no need to describe the full purpose of the changes or how they work together. If you think that a change calls for explanation, you're probably right. Please do explain it--but please put the explanation in comments in the code, where people will see it whenever they see the code. For example, "New function" is enough for the change log when you add a function, because there should be a comment before the function definition to explain what it does.
The commentary should alert the user as to issues with the relevant
code, explaining, where applicable, why apparently simpler alternative
techniques don't work.
Andrew