Skip to content

Commit

Permalink
Nitpicks, round 1
Browse files Browse the repository at this point in the history
  • Loading branch information
mvandervoord committed Jan 1, 2025
1 parent b410ae0 commit f5d2c9e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
========

_December 29, 2024_ 🚚 **Ceedling 1.0.0** is a release candidate and will be
shipping very soon. See the [Release Notes](docs/ReleaseNotes.md) for an overview
Welcome to **Ceedling 1.0.0**

See the [Release Notes](docs/ReleaseNotes.md) for an overview
of all that’s new since 0.31.1 plus links to the detailed Changelog and list of
Breaking Changes.

Expand All @@ -13,11 +14,11 @@ Breaking Changes.
Ceedling can build your release artifact but is especially adept at building
unit test suites for your C projects — even in tricky embedded systems.

Ceedling and its complementary pieces and parts are and always will be freely
available and open source. **_[Ceedling Pro][ceedling-pro]_** is a growing list
Ceedling and its complementary pieces and parts are (and always will be) freely
available and open source. **_[Ceedling Assist][ceedling-pro]_** is a growing list
of paid products and services to help you do even more with these tools.

[ceedling-pro]: https://thingamabyte.com/ceedlingpro
[ceedling-pro]: https://www.thingamabyte.com/ceedling

⭐️ **Eager to just get going? Jump to
[📚 Documentation & Learning](#-documentation--learning) and
Expand Down
2 changes: 1 addition & 1 deletion docs/BreakingChanges.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This behavior is no more. Why? For two interrelated reasons.
1. For large or complex projects, expansive header file search path lists can exceed command line maximum lengths on some platforms. An enforced, tailored set of search paths helps prevent this problem.
1. In order to support the desired behavior of `TEST_INCLUDE_PATH()` a concice set of “base” header file search paths is necessary. `:paths``:include` is that base list.

Using 0.32 Ceedling with older project files can lead to errors when generating mocks or compiler errors on finding header files. Add all relevant header file search paths to the `:paths``:include` project file entry to fix this problem.
Using 1.0+ Ceedling with older project files can lead to errors when generating mocks or compiler errors on finding header files. Add all relevant header file search paths to the `:paths``:include` project file entry to fix this problem.

## Format change for `:defines` in the project file

Expand Down
2 changes: 1 addition & 1 deletion docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ This new plugin also includes the option to generate an HTML report (see next se

### HTML tests report

A community member submitted an [HTML report generation plugin](https://github.com/ThrowTheSwitch/Ceedling/pull/756/) that was not officially released before 0.32. It has been absorbed into the new `report_tests_log_factory` plugin (see previous section).
A community member submitted an [HTML report generation plugin](https://github.com/ThrowTheSwitch/Ceedling/pull/756/) that was not officially released before 1.0. It has been absorbed into the new `report_tests_log_factory` plugin (see previous section).

### Improved Segfault Handling

Expand Down
4 changes: 1 addition & 3 deletions docs/PluginDevelopmentGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,9 @@ Ceedling plugins or by simply searching for code examples online.

## Development Roadmap & Notes

_November 28, 2024_

(See Ceedling's _[release notes](ReleaseNotes.md)_ for more.)

* Ceedling 0.32 marks the beginning of moving all of Ceedling away from relying
* Ceedling 1.0 marks the beginning of moving all of Ceedling away from relying
on Rake. New, Rake-based plugins should not be developed. Rake dependencies
among built-in plugins will be refactored as the transition occurs.
* Ceedling's entire plugin architecture will be overhauled in future releases.
Expand Down

0 comments on commit f5d2c9e

Please sign in to comment.