mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2024-10-28 03:59:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
cdt/NewAndNoteworthy
History
Jonah Graham 2777c17784 Simplify API document 
Removed the manually maintained table of contents, instead use
the contents feature in GitHub to navigate. The spans have
all been removed because they were not working anyway, at least
on github.

This change was inspired by PR #336 where a contributor was updating
this document and I didn't think it was a great idea to send it back
to them to add the TOC entry.
2023-04-10 10:25:47 -04:00
..
images Bug 571722: Add ALL_FLAGS for scanner discovery 2022-11-21 10:46:49 -05:00
OlderReleases Migrate New and Noteworthy from Wiki to GitHub 2022-10-02 20:46:56 -04:00
CDT-10.0.md Update wiki.eclipse links to their new locations 2022-11-09 10:56:55 -05:00
CDT-10.1.md Update wiki.eclipse links to their new locations 2022-11-09 10:56:55 -05:00
CDT-10.2.md Move https://wiki.eclipse.org/CDT/StandaloneDebugger to GitHub 2022-11-09 10:56:55 -05:00
CDT-10.3.md Migrate New and Noteworthy from Wiki to GitHub 2022-10-02 20:46:56 -04:00
CDT-10.4.md Migrate New and Noteworthy from Wiki to GitHub 2022-10-02 20:46:56 -04:00
CDT-10.5.md Migrate New and Noteworthy from Wiki to GitHub 2022-10-02 20:46:56 -04:00
CDT-10.6.md Update wiki.eclipse links to their new locations 2022-11-09 10:56:55 -05:00
CDT-10.7.md Migrate New and Noteworthy from Wiki to GitHub 2022-10-02 20:46:56 -04:00
CDT-11.0.md Add lack Dwarf5 support to release notes 2022-12-07 19:54:49 -05:00
CDT-11.1.md CDT 11.1.1 Release Notes updates 2023-03-20 09:27:32 -04:00
CDT-11.2.md [releng] Prepare repo for CDT 11.2 development 2023-03-13 13:54:48 -04:00
CHANGELOG-API.md Simplify API document 2023-04-10 10:25:47 -04:00
README.md Correct year of 11.2 expected release 2023-03-17 10:53:30 -04:00

README.md

CDT Release Notes and New & Noteworthy

What's new and noteworthy in:

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.