doc: Use libxkbcommon for explicit library references#1006
Draft
wismill wants to merge 1 commit into
Draft
Conversation
“xkbcommon” and “libxkbcommon” are both used throughout the code base to refer loosely to either the meta-project or the library, which may bring some confusion (see [xkbcommon#953]). The meta-project is xkbcommon and has currently two projects: - a library: libxkbcommon (the “xkbcommon library”) - a CLI tool: xkbcli Fixed by using “libxkbcommon” instead of “xkbcommon” when referring explicitly to the library. [xkbcommon#953]: xkbcommon#953
wismill
added
the
documentation
Contributor
|
I think @fooishbar might have more info, in my head it was always libxbkcommon and i have to shift gear to think of it as xkbcommon - though that's the URL etc. |
Member
Author
etc. Source: https://www.fooishbar.org/blog/xkbcommon-intro/ |
Member
|
I’d always personally thought of the name as xkbcommon, but a) I sort of inherited it from Dan Nicholson, and b) this project hasn’t been my project for over 10 years now! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
“xkbcommon” and “libxkbcommon” are both used throughout the code base to refer loosely to the library, which may bring some confusion (see #953).
The meta-project is xkbcommon and has currently two projects:
I am also thinking to have some
libxkbcommon-<lang>“official” bindings.Fixed by using “libxkbcommon” instead of “xkbcommon” when referring explicitly to the library.
Fixes #953
TODO:
Caution
@fooishbar @bluetech @whot Is the naming distinction between project and lib actually correct? Digging in the git log it seems this confusion has been present since the early stages of the project.
I mean, we (devs) all understand the terms depending on their context, but it matters for third-party and search referencing.