Wireshark-commits: [Wireshark-commits] master 23f5b13: Improve the documentation of tvb_new_subset_
Date Index · Thread Index · Other Months · All Mailing Lists
Date Prev · Date Next · Thread Prev · Thread Next
From: Wireshark code review <code-review-do-not-reply@xxxxxxxxxxxxx>
Date: Tue, 10 Apr 2018 18:01:59 +0000
URL: https://code.wireshark.org/review/gitweb?p=wireshark.git;a=commit;h=23f5b1336974850de62a8a10be46b4fbd5869d0b
Submitter: Guy Harris (guy@xxxxxxxxxxxx)
Changed: branch: master
Repository: wireshark

Commits:

23f5b13 by Guy Harris (guy@xxxxxxxxxxxx):

    Improve the documentation of tvb_new_subset_ routines.
    
    First mention tvbuff_new_subset_remaining(), as that's good enough for
    most uses.
    
    Then mention tvb_new_subset_length(), which is what most of the
    remaining cases should use; we weren't even documenting it.
    
    Then mention tvb_new_subset_length_caplen(); we want that to be used
    only when *absolutely* necessary.
    
    Change-Id: I57a6c202d4a68b001ddca8bd4c7e1d271eb52ef9
    Reviewed-on: https://code.wireshark.org/review/26864
    Reviewed-by: Guy Harris <guy@xxxxxxxxxxxx>
    

Actions performed:

    from  b3c51de   Rename the last argument to tvb_new_subset_length().
    adds  23f5b13   Improve the documentation of tvb_new_subset_ routines.


Summary of changes:
 doc/README.dissector | 40 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)