Hi guys, I have added a little page with some information on the coding style used in VIFF:
http://viff.dk/docs/coding-style.html I also added some "buttons" in a header -- I chose a simple and very old-school way of doing this: links in square brackets. I wanted to keep things simple, but perhaps it would be better to turn the links into proper buttons as on the frontpage? Comments are very welcome! (Comments with patches are even more welcome, remember that you can checkout the website from http://hg.viff.dk/viff.dk/.) I am also making a document which will describe VIFF from the perspective of someone who wants to change it -- I called it hacking.txt as a start to continue the long tradition of including a HACKING file along side the README and INSTALL files. My idea for the document is that it should contain the more detailed explainations which aren't suitable for docstrings. There is already some quite long (too long, I think) docstrings in runtime.py explaining stuff like program counters. I think it would be better to make a short docstring which references a webpage instead. On the other hand, it might be a bad idea to spread the documentation over too many places -- it will probably be easier to forget to update it then. And people might end up with code on their systems for which the documentation is no longer online (though they can always find it in the website repository). Again, let me know what you think of this... I would like to get input on what kind of subjects you want me to write about. I think there should be something that answers concrete task- oriented questions like: * Tord: I want to implement my super comparison protocol which uses no rounds, no multiplications, no players, no everything! How do I start? * Thomas: How do I create a new unit test? Not just one, I want to create many with randomized parameters! What to do? Those kind of questions :-) And some details on the program counter magic, not just how it works but also why it is necessary in the first place. That was all for now -- now I must go back to my slides for my qualification exam on Thursday... -- Martin Geisler
pgp6T7D1hgL9F.pgp
Description: PGP signature
_______________________________________________ viff-devel mailing list (http://viff.dk/) [email protected] http://lists.viff.dk/listinfo.cgi/viff-devel-viff.dk
