Re: [cdt-dev] Documenting broken APIs

[Marc Khouzam <marc.khouzam@xxxxxxxxxxxx>]

Agreed.
This will require committers to pay attention to changes they accept.  I highly recommend documenting changes as soon as they come in.  Besides allowing extenders that use master to know what to do right away, I think it will make it easier to find such changes.

The API tool does have a preference to "Report API breakage even if authorized by major increment".  This will allow to find the changes made, but will require a big effort if done all at once. Doing it gradually will surely be better.

I have created a section in the N&N:
https://wiki.eclipse.org/CDT/User/NewIn90#API_modifications

I believe something should be put there for the recent changes in autotools :-)

Thanks

Marc

---

From: cdt-dev-bounces@xxxxxxxxxxx [cdt-dev-bounces@xxxxxxxxxxx] on behalf of Doug Schaefer [dschaefer@xxxxxxx]
Sent: October 21, 2015 1:35 PM
To: CDT General developers list.
Subject: Re: [cdt-dev] Documenting broken APIs

Yes, this information is absolutely important.

From: <cdt-dev-bounces@xxxxxxxxxxx> on behalf of Marc Khouzam <marc.khouzam@xxxxxxxxxxxx>
Reply-To: "CDT General developers list." <cdt-dev@xxxxxxxxxxx>
Date: Wednesday, October 21, 2015 at 1:10 PM
To: "CDT DEV (cdt-dev@xxxxxxxxxxx)" <cdt-dev@xxxxxxxxxxx>
Subject: [cdt-dev] Documenting broken APIs

Hi,

with the CDT 9.0 release allowing to modify APIs, some non-backwards compatible changes have already gone in to master.  That is fine.

Is it of value to document those changes in detail in the N&N page?
I feel it is something important to help people deal with compilation errors due to those API changes.  However if people feel like they can manage easily without that info, let's not spend time on it.

Is a list of API changes something important for extenders?

Thanks

Marc