Skip to content
  • Ben Ford's avatar
    build: Revise CHANGES and UPGRADE.txt handling. · a4ab7f5f
    Ben Ford authored
    This changes the way that we handle adding changes to CHANGES and
    UPGRADE.txt. The reason for this is because whenever someone needed to
    make a change to one of these files and someone else had already done
    so, you would run into merge conflicts. With this new setup, there will
    never be merge conflicts since all changes will be documented in the
    doc/<file>-staging directory. The release script is now responsible for
    merging all of these changes into the appropriate files.
    
    There is a special format that these files have to follow in order to be
    parsed. The files do not need to have a meaningful name, but it is
    strongly recommended. For example, if you made a change to pjsip, you
    may have something like this "res_pjsip_relative_title", where
    "relative_title" is something more descriptive than that. Inside each
    file, you will need a subject line for your change, followed by a
    description. There can be multiple subject lines. The file may look
    something like this:
    
       Subject: res_pjsip
       Subject: Core
    
       A description that explains the changes made and why. The release
       script will handle the bulleting and section separators!
    
       You can still separate with new lines within your
       description.
    
    The headers ("Subject" and "Master-Only") are case sensative, but the
    value for "Master-Only" ("true" or "True") is not.
    
    For more information, check out the wiki page:
    https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt
    
    ASTERISK-28111 #close
    
    Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47
    a4ab7f5f