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

Remove sds from user-facing API #86

Merged
merged 4 commits into from
Sep 4, 2024
Merged

Conversation

bjosv
Copy link
Collaborator

@bjosv bjosv commented Sep 3, 2024

  • Make sds.h private.
  • Remove sds from cluster API.
  • Make valkeyFormatSdsCommandArgv private.
    Originated from redis/hiredis@40f7035
  • Remove convenience function valkeyFreeSdsCommand.
    Originated from redis/hiredis@9a753b4

TODO: add following to migration-guide.md

## Migrating from `hiredis` v1.2.0

The type `sds` is removed from the public API.

### Removed API functions

* `valkeyFormatSdsCommandArgv` removed from API. Can be replaced with `valkeyFormatCommandArgv`.
* `valkeyFreeSdsCommand` removed since the `sds` type is for internal use only.

Closes #13

Originated from:
redis/hiredis@40f7035

Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
@zuiderkwast
Copy link
Collaborator

It's called valkeyFormatSdsCommandArgv in this project, not redisFormatSdsCommandArgv. (Just a typo in the PR description.)

Looks good to me, but @michael-grunder PTAL.

Copy link
Collaborator

@michael-grunder michael-grunder left a comment

Choose a reason for hiding this comment

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

Sorry for the delay, I was away for a few days

@bjosv bjosv merged commit 5bb15a9 into valkey-io:main Sep 4, 2024
41 checks passed
@bjosv bjosv deleted the remove-sds-from-api branch September 4, 2024 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove sds from user-facing API
3 participants