reminder: please add "API CHANGE" to commit message if you change the API incompatibly

Michael Stahl mstahl at redhat.com
Thu Jul 30 05:04:03 PDT 2015


as i recently noticed while finally writing the API change section for
the 4.4 release notes (and it was about time...), almost none of the
commits that do change the API in some (theoretically or practically)
incompatible way between 4.3 and 4.4 had the required "API CHANGE"
notice in the commit message, which made writing the release notes more
difficult.

please if you change something incompatibly in the API put the required
"API CHANGE" marker in the commit message.

as a reminder our public API consists of the following:

* UNO API
  udkapi/
  offapi/

* C++ URE
  include/com
  include/cppu
  include/cppuhelper
  include/osl
  include/rtl
  include/sal
  include/salhelper
  include/systools
  include/typelib
  include/uno

* Java URE
  javaunohelper/
  jurt/
  ridljar/

* Java Bean
  bean/

* Python PyUNO
  pyuno/

* codemaker is effectively sort of part of the ABI, in case the
  generated code would change in an incompatible manner

* Configuration
  officecfg/

there are probably more obscure bits that i forget... do ActiveX or OLE
automation bridge define any LO-specific interfaces?

PS: Matus gets a honourable mention since while he did forget to add it
in the commit message he at least added the change to the release notes
himself



More information about the LibreOffice mailing list