>>> In some cases, remove option descriptions since the text >>> just repeats the help output. >>>
Poor choice of words on my part: The help output is actually included in the WSUG. I agree completely that one should only need to look in one place for information. When I started to update the WSUG, I noticed that, in actuality, certain of the text in the WSUG describing the specific options for several of the individual programs repeated the program help text almost literally. Since the help text for those programs is actually included in the WSUG, it seemed reasonable to not repeat things. (I updated the help text included in the WSUG with the current help text). In one or two cases where the text I removed was a bit better than the help output, I revised the help output in the program. As far as I know, I removed only text which repeated the help file output already in the WSUG and not any of the additional explanatory material. I'll double-check to verify that this is the case. Bill Jaap Keuter wrote: > Hi, > > Indeed, the updates are good, but dropping the more extensive option > descriptions is not what you want from a users guide. It is *the* place to go > if > an option needs clarification. > > Thanx, > Jaap > > Joerg Mayer wrote: >> On Tue, May 12, 2009 at 04:11:59PM +0000, [email protected] wrote: >>> http://anonsvn.wireshark.org/viewvc/viewvc.cgi?view=rev&revision=28335 >>> >>> In some cases, remove option descriptions since the text >>> just repeats the help output. >>> >>> +191 -408 WSUG_app_tools.xml Modified >> Is that really what we want? Is someone who looks at the UG also required >> to look at the second, third, ... document (man pages) to find out the >> command line options? >> >> ciao >> Joerg > > ___________________________________________________________________________ > Sent via: Wireshark-dev mailing list <[email protected]> > Archives: http://www.wireshark.org/lists/wireshark-dev > Unsubscribe: https://wireshark.org/mailman/options/wireshark-dev > mailto:[email protected]?subject=unsubscribe > > ___________________________________________________________________________ Sent via: Wireshark-dev mailing list <[email protected]> Archives: http://www.wireshark.org/lists/wireshark-dev Unsubscribe: https://wireshark.org/mailman/options/wireshark-dev mailto:[email protected]?subject=unsubscribe
