Ethereal-dev: Re: [Ethereal-dev] README.developer

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

Date Index Thread Index Other Months All Mailing Lists
Date Prev Date Next Thread Prev Thread Next
From: Guy Harris <guy@xxxxxxxxxx>
Date: Thu, 28 Feb 2002 15:18:59 -0800
On Thu, Feb 28, 2002 at 09:59:40AM -0500, packet steve wrote:
> doc/README.developer mentions proto_tree_set_text and 
> proto_tree_append_text.  Should these be marked obsolete

No, they shouldn't.

As you can no longer create a protocol tree item with no text - because
if you do, and fill in the text as you dissect stuff, if you throw an
exception you can end up with a protocol tree item with no text, which
looks bogus - "proto_tree_set_text()" might not be useful (although it's
still being used).

"proto_tree_append_text()", however, was put in specifically to *fix*
that problem!  You create an item with enough text to have it tell the
user *something*, and then, as you dissect it, you append additional
information to the text.

So perhaps "proto_tree_set_text()" can be marked obsolete if we get rid
of all uses of it (i.e., if we can show that it's not needed) - but,
once you've done that, you might as well just remove it, entirely.

"proto_tree_append_text()", is *not* obsolete, and thus should not be
marked as such.

> or simply removed from the README?

No, they shouldn't, for the same reasons.