Skip to content

Commit

Permalink
changelog for v0.1.0-alpha.2
Browse files Browse the repository at this point in the history
  • Loading branch information
abhishekmishra committed Feb 21, 2023
1 parent ad2b288 commit e7f49e8
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
27 changes: 22 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# CHANGELOG
This file documents major changes in every release of the project. The project follows [Semantic Versioning](https://semver.org/). There is a section for each release - which lists major changes made in the release.

**0.1.0-alpha.2** 2023-02-21 Abhishek Mishra <abhishekmishra3@gmail.com>

- This is the 3rd alpha release. It incorporates one major feature and some
minor API changes and bug fixes.
- Added lua module implementation for zclk, along with some sample programs.
- Minor api changes to add const qualifier where it makes sense.
- The flag and boolean options don't need a default value as it is always
false.

**0.1.0-alpha.1** 2023-01-21 Abhishek Mishra <abhishekmishra3@gmail.com>

- This is the second alpha release. It incorporates major changes in API, and a few minor improvements in error handling.
- All public API functions that accept strings now use `const char *` instead of `char *`. All strings are cloned internally before usage.
- New functions added to retrieve options and arguments from the command object using their names. This is more convenient and produces more readable code than looping over the options and arguments and conditional operation over the names.
- The public APIs creating options and arguments is fixed to accept only `default_val`. The `val` property of the corresponding options or argument is set initially to `default_val`.
- Some error messages are added for common errors in parsing options and arguments. This mechanism might change in a future version.
- This is the second alpha release. It incorporates major changes in API, and
a few minor improvements in error handling.
- All public API functions that accept strings now use `const char *` instead
of `char *`. All strings are cloned internally before usage.
- New functions added to retrieve options and arguments from the command object
using their names. This is more convenient and produces more readable code
than looping over the options and arguments and conditional operation over
the names.
- The public APIs creating options and arguments is fixed to accept only
`default_val`. The `val` property of the corresponding options or argument is
set initially to `default_val`.
- Some error messages are added for common errors in parsing options and
arguments. This mechanism might change in a future version.
- A few minor build issues, compiler warnings, and a logic error were fixed.

**0.1.0-alpha.0** 2023-01-14 Abhishek Mishra <abhishekmishra3@gmail.com>
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ set( ZCLK_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR} )
set ( ZCLK_VERSION_MAJOR "0" )
set ( ZCLK_VERSION_MINOR "1" )
set ( ZCLK_VERSION_PATCH "0" )
set ( ZCLK_VERSION_PRERELEASE "-alpha.1" )
set ( ZCLK_VERSION_PRERELEASE "-alpha.2" )
set ( ZCLK_VERSION_STR ${ZCLK_VERSION_MAJOR}.${ZCLK_VERSION_MINOR}.${ZCLK_VERSION_PATCH}${ZCLK_VERSION_PRERELEASE})

# https://stackoverflow.com/a/47260387/9483968
Expand Down
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "ZClk"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.1.0-alpha.1
PROJECT_NUMBER = 0.1.0-alpha.2

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down

0 comments on commit e7f49e8

Please sign in to comment.