Wireshark · Wireshark-commits: [Wireshark-commits] master efd7cb3: doc: explain when to use FT_STRINGZ, and document FT_STRINGZPAD.

[Wireshark code review <code-review-do-not-reply@xxxxxxxxxxxxx>]

URL: https://code.wireshark.org/review/gitweb?p=wireshark.git;a=commit;h=efd7cb38e67cbfd3333a8c2fd4bc47aaec4ba83c
Submitter: "Guy Harris <gharris@xxxxxxxxx>"
Changed: branch: master
Repository: wireshark

Commits:

efd7cb3 by Guy Harris (gharris@xxxxxxxxx):

    doc: explain when to use FT_STRINGZ, and document FT_STRINGZPAD.
    
    FT_STRINGZ should be used *ONLY* if the string is *ALWAYS* supposed to
    have a null terminator, either because the length isn't otherwise
    specified, so that it can only be determined by finding the terminating
    null character, or because a character count *and* a NULL terminator are
    both used (yes, there appear to be some cases where that's true).
    
    FT_STRINGZPAD is null-padded rather than null-terminated; this is
    typically used for fixed-length fields that contain a string value that
    might be shorter than the fixed length.
    
    Change-Id: Ifdf421ca666482583a4dfc76167eae6dc473f48a
    Reviewed-on: https://code.wireshark.org/review/38137
    Reviewed-by: Guy Harris <gharris@xxxxxxxxx>
    

Actions performed:

    from  9eddbda   Don't give a zero-length FT_STRINGZ a special value.
     add  efd7cb3   doc: explain when to use FT_STRINGZ, and document FT_STRINGZPAD.


Summary of changes:
 doc/README.dissector | 13 +++++++++++++
 1 file changed, 13 insertions(+)