Skip to content

Remove sds from user-facing API #86

Merged
bjosv merged 4 commits intovalkey-io:mainfrom
bjosv:remove-sds-from-api
Sep 4, 2024
Merged

Remove sds from user-facing API #86
bjosv merged 4 commits intovalkey-io:mainfrom
bjosv:remove-sds-from-api

Conversation

@bjosv
Copy link
Copy Markdown
Collaborator

@bjosv bjosv commented Sep 3, 2024 •
edited
Loading

  • 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

bjosv added 4 commits September 3, 2024 15:40
@bjosv
Remove convenience function valkeyFreeSdsCommand(cmd)
fba03aa 
Originated from:
redis/hiredis@9a753b4

Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv
Make redisFormatSdsCommandArgv private
d8fa373 
Originated from:
redis/hiredis@40f7035

Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv
Remove sds from cluster API
a590ab2 
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv
Make sds.h private
67badd6 
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@zuiderkwast
Copy link
Copy Markdown
Collaborator

zuiderkwast commented Sep 3, 2024

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

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

michael-grunder
michael-grunder approved these changes Sep 3, 2024
View reviewed changes
Copy link
Copy Markdown
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
@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

Reviewers

@michael-grunder michael-grunder michael-grunder approved these changes

@zuiderkwast zuiderkwast Awaiting requested review from zuiderkwast

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Remove sds from user-facing API

3 participants

@bjosv @zuiderkwast @michael-grunder