Skip to content

Commit

Permalink
doc: fix typos in API_POLICY.md
Browse files Browse the repository at this point in the history
Fixes #13

Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
  • Loading branch information
bhufmann committed Feb 12, 2024
1 parent e1abdb7 commit 1d5703a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions API_POLICY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Trace Compass project provides APIs for building custom trace analysis and v
* Optionally open a bug report to discuss the API deprecation
* In the java-doc, add a @deprecated tag with a description if the reason for deprecation (optional), and provide steps for how to replace their usage with an alternative implementation. Note that deprecated APIs still have to work as originally specified.
* Mark the API element with @Deprecated annotation
* In the commit message, have one or more lines with starting with [Deprecated] to describe the deprecation. This lines will be shown in the [Note&Noteworthy][nan] of the following release.
* In the commit message, have one or more lines with starting with [Deprecated] to describe the deprecation. This lines will be shown in the [New&Noteworthy][nan] of the following release.
* Push the change to Gerrit. Trace Compass committers will review and provide feedback.

## Identifying Deprecated API
Expand All @@ -34,14 +34,14 @@ To remove deprecated APIs, a Trace Compass committer will do the following steps
* Provide pull requests that remove API
* Add reference of the issue tracker
* In the commit message, add the commit sha of the commit where it was deprecated
* In the commit message, have one or more lines with starting with [Removed] line to describe the removal(s) which will be picked up in the News@Noteworthy
* In the commit message, have one or more lines with starting with [Removed] line to describe the removal(s) which will be picked up in the [New&Noteworthy][nan]
* Example: [Bug 579484: Remove deprecated segmentstore.SubSecondTimeWithUnitFormat][example-patch]

## Retention Policy

The Eclipse Trace Compass policy is to maintain deprecated API for at least one major release cycle. For example, if an API was deprecated for the minor release 6.3 in March 2021, and another API was deprecated for major release 7.0 in June 2021, both APIs can be removed for release 8.0 in June 2022. The retention time will give adopters at least 1 year, and usually 3 minor releases, time to adjust their code base before APIs are removed.

API clients should follow the Trace Compass [Note&Noteworthy](nan) for each release to know about API deprecation of a release and plan to prepare their code base for the removal of APIs after this retention time. At any time after the deprecation, adopters can provide feedback and discuss to keep the deprecated API via bugzilla bug report. The announcement on the mailing list will provide a final warning where adopters can raise their concerns or adapt to the API changes.
API clients should follow the Trace Compass [New&Noteworthy][nan] for each release to know about API deprecation of a release and plan to prepare their code base for the removal of APIs after this retention time. At any time after the deprecation, adopters can provide feedback and discuss to keep the deprecated API via bugzilla bug report. The announcement on the mailing list will provide a final warning where adopters can raise their concerns or adapt to the API changes.

[Bug572888]: https://bugs.eclipse.org/bugs/show_bug.cgi?id=572888
[example-patch]: https://git.eclipse.org/r/c/tracecompass/org.eclipse.tracecompass/+/193428
Expand Down

0 comments on commit 1d5703a

Please sign in to comment.