[Bro-Dev] [JIRA] (BIT-924) String BIFs Return 1-indexed string_arrays

Jon Siwek (JIRA) jira at bro-tracker.atlassian.net
Fri Oct 31 08:34:08 PDT 2014

    [ https://bro-tracker.atlassian.net/browse/BIT-924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18616#comment-18616 ] 

Jon Siwek commented on BIT-924:

I think more generally, we want a good way to be able to make breaking changes to BIFs and the base scripts, which can be thought of as an API.


With this kind of notification, I could see a staged approach to "fix" these string functions (using split as an example, obviously extended to all the functions above):
Create split_0 and deprecate split
Rename split_0 to split, create a deprecated split_1 that implements the old functionality
Remove split_1

Is it reasonable to expect a user to never "skip a release version" ?  Because if they did, they may miss a deprecation warning and just be silently using the breaking change.  But yeah, maybe the best that can be done here to clearly indicate in NEWS which breaking changes a user will need to audit their code for and also provide helpful hints in the form of deprecated usage warnings for a limited time.

> String BIFs Return 1-indexed string_arrays
> ------------------------------------------
>                 Key: BIT-924
>                 URL: https://bro-tracker.atlassian.net/browse/BIT-924
>             Project: Bro Issue Tracker
>          Issue Type: Problem
>          Components: Bro
>    Affects Versions: git/master
>            Reporter: grigorescu
>             Fix For: 2.4
> The following BIFs return 1-indexed string_arrays:
> * sort_string_array
> * split
> * split1
> * split_all
> * split_n

This message was sent by Atlassian JIRA

More information about the bro-dev mailing list