Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 6.67 KB

README.md

File metadata and controls

108 lines (80 loc) · 6.67 KB

CDT Release Notes and New & Noteworthy

What's new and noteworthy in:

CDT LSP

The CDT LSP (LSP based C/C++ Editor) provides its own changelog highlighting its release notes and new and noteworthy entries.

Older Versions

Older Versions

Older Versions

Older versions of CDT's New & Noteworthy page have not been converted from Wikitext to GitHub markdown, instead these older pages have simply been saved from the browser to preseve them. This may lead to some minor rendering issues that hopefully do not detract too much from the overall information provided.

API Changes

The Eclipse CDT project announces and tracks breaking API changes in CHANGELOG-API.

How to write a New & Noteworthy entry

How to write a New & Noteworthy entry

Use the model of any of the previous New & Noteworthy entry pages as a starting point. CDT 10.3/2021-06 is a fairly extensive entry and is a useful page to copy examples from.

Using Images

Upload images to the images/ subfolder and prefix the file with the version number, e.g. CDT-10.5-. The images should be embedded using the <img> tag with (gernally) a width of 50% like this:

<p align="center"><img src="images/CDT-10.0-CTAD.jpg" width="50%"></p>

Referecing Code

Especially when writing New & Noteworthy entries about API it is useful to link to the file. This should be done using a relative path, such as:

The [SerialPort](../native/org.eclipse.cdt.native.serial/src/org/eclipse/cdt/serial/SerialPort.java) supports arbitrary baud rates.

which renders like this:

The SerialPort supports arbitrary baud rates.

API Changes and Improvements

Improvements and changes to API should be announced in the New and Noteworthy for the release so they get visibility. Linking directly to the code or Javadoc for the new API is encouraged.

API Breakages and Removals

Anything that breaks or removes API should be listed in the CHANGELOG-API. If the API change is very significant (such as a new version of Java) listing it in the New and Noteworthy for the release is also advisable.