Hi,

as there is no documentation of internals, may be we should think about at
least to document it from the sources using a tool like doxygen. This would
need some rework of the code comments, but I think this would evolve when
people try to understand the code and write patches they might also add some
doc comments to existing functions. (I guess I would also use some of my
spare time to document some functions and setup doxygen in the Makefiles.)

For most programmers it would make sense to add a file-comment describing
the handling of the programmer in general, and adding specific explanations
to functions itself.


Kind regards

René Liebscher


-----Ursprüngliche Nachricht-----
Von: avrdude-dev-bounces+r.liebscher=gmx...@nongnu.org
[mailto:avrdude-dev-bounces+r.liebscher=gmx...@nongnu.org] Im Auftrag von
Joerg Wunsch
Gesendet: Donnerstag, 1. November 2012 08:07
An: Tobias Kaiser; Joerg Wunsch; avrdude-dev@nongnu.org
Betreff: [avrdude-dev] [patch #7538] Add support for AT89S52/51 MCS-51 MPUs

Follow-up Comment #3, patch #7538 (project avrdude):

> Where can I find the preamble in the patch tracker?

Just try submitting a new patch, and you'll see it.  (Don't
complete the procedure, just start it, pretending you were
submitting something new.)

>  Should I submit a patch containing further program
> internal documentation?

There is no document for internal stuff, so your patch should
include respective comments.

> Will the patch afterwards be applied to the avrdude source

I generally don't make promises about what is going to be
included in the next release (because I have to find the
respective spare-time), but if everything fits and is
documented, chances are good.

    _______________________________________________________

Reply to this item at:

  <http://savannah.nongnu.org/patch/?7538>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.nongnu.org/


_______________________________________________
avrdude-dev mailing list
avrdude-dev@nongnu.org
https://lists.nongnu.org/mailman/listinfo/avrdude-dev


_______________________________________________
avrdude-dev mailing list
avrdude-dev@nongnu.org
https://lists.nongnu.org/mailman/listinfo/avrdude-dev

Reply via email to