Douglas Pratley wrote:
> May I suggest that a section is added to the Developers Guide and / or
> Readme.developer that just points out that the documentation source _is_
> part of the Wireshark source and can be found in /docbook and built
> according to the instructions in the readme there. And that people are
> expected to update it...

If that's the case, we should also point people to the Docbook tools and 
indicate that they should install them.

Note, though, that we should perhaps distinguish between dissector 
developers, who don't need to update any documentation when they add a 
dissector, and tap developers and other developers of features with a 
user interface (other than a pane in the Preferences dialog), who 
*should* update the documentation.  Then again, perhaps we *should* 
document the preferences for dissectors in the User's Guide, in which 
case, if you're going to be contributing your dissector to the Wireshark 
code base, you should update the documentation as well....
_______________________________________________
Wireshark-dev mailing list
Wireshark-dev@wireshark.org
http://www.wireshark.org/mailman/listinfo/wireshark-dev

Reply via email to