Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(linux): Rename KBP to CORE 〽️ #9794

Merged
merged 2 commits into from
Oct 20, 2023

Conversation

ermshiperete
Copy link
Contributor

Part of #9733.

@keymanapp-test-bot skip

@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Oct 18, 2023

Copy link
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good cleanups; I think we should tweak a few of the names slightly more though

@@ -25,7 +25,7 @@ typedef KMX_WORD __attribute__((aligned(1))) KMX_WORD_unaligned;
#define KMX_WORD_unaligned KMX_WORD
#endif

#ifdef KMN_KBP
#ifdef KMN_CORE
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everywhere else the prefix is KM_CORE, do we want to use the same, and some thing after to make it clear it's a preprocessor control, e.g. KM_CORE_LIBRARY?

#endif

#if defined KMN_KBP_STATIC
#if defined KMN_CORE_STATIC
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KM_CORE_LIBRARY_STATIC?

#define KMN_API _kmn_tag_fn(_kmn_static_flag)
#define KMN_DEPRECATED_API _kmn_tag_fn(_kmn_deprecated_flag _kmn_and _kmn_static_flag)
#elif defined KMN_KBP_EXPORTING
#elif defined KMN_CORE_EXPORTING
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KM_CORE_LIBRARY_EXPORTING?

Comment on lines 62 to 63
#ifndef KMN_CORE
#define KMN_CORE
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KM_CORE_LIBRARY?

@@ -75,7 +75,7 @@ namespace kbp
* updateing the state as required.
*
* @param state An opaque pointer to a state object
* @return km_core_status `KM_CORE_STATUS_OK`: On success. Else KB_KBP_ error code
* @return km_core_status `KM_CORE_STATUS_OK`: On success. Else KB_CORE_ error code
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @return km_core_status `KM_CORE_STATUS_OK`: On success. Else KB_CORE_ error code
* @return km_core_status `KM_CORE_STATUS_OK`: On success. Else KM_CORE_ error code

@@ -23,7 +23,7 @@
VALUE "InternalName", "Keyman Core"
VALUE "LegalCopyright", "© SIL International"
VALUE "LegalTrademarks", ""
VALUE "OriginalFilename", "KMNKBP0-0.DLL"
VALUE "OriginalFilename", "KMNCORE0-0.DLL"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
VALUE "OriginalFilename", "KMNCORE0-0.DLL"
VALUE "OriginalFilename", "KEYMANCORE0-0.DLL"

I also wonder about the need to append 0-0, surely we should be using the actual version?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The next PR (#9793) updates the version number. But I don't think we want to use 17 as version number since this is the Core API version which usually doesn't change in breaking ways between Keyman versions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. We just need to have a documented version number for the API then

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Created #9801.

@github-actions github-actions bot added linux/ and removed linux/ labels Oct 19, 2023
@ermshiperete ermshiperete merged commit b177df2 into master Oct 20, 2023
17 checks passed
@ermshiperete ermshiperete deleted the chore/linux/9733_RenameDefines branch October 20, 2023 10:29
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 17.0.196-alpha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants