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

Rename "External Matchfinder" to "Block-Level Sequence Producer" #3484

Merged
merged 9 commits into from
Feb 9, 2023

Conversation

embg
Copy link
Contributor

@embg embg commented Feb 8, 2023

"External matchfinder" was an inaccurate name, since the user-provided callback selects which match to use at each position as well as finding multiple matches for each position. The updated term we are using is "sequence provider".

Original PR introducing the old term (title of the old PR has been updated): #3333

Here are the commands I used to migrate names in lib/ and tests/:

find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/externalMatchState/sequenceProducerState/g' {} \;
find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/ExternalMatchState/SequenceProducerState/g' {} \;
find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/externalMatchFinder/sequenceProducer/g' {} \;
find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/ExternalMatchFinder/SequenceProducer/g' {} \;
find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/ZSTD_EXTERNAL_MATCHFINDER_ERROR/ZSTD_SEQUENCE_PRODUCER_ERROR/g' {} \;
find ./ -type f \( -name "*.c" -o -name "*.h" \) -exec sed -i 's/ZSTD_c_enableMatchFinderFallback/ZSTD_c_enableSeqProducerFallback/g' {} \;

TODOs:

  • Update all public headers and contrib/externalMatchfinder
  • Update fuzzer makefile (references contrib)
  • Open an issue to track migration of internal names / comments in lib/ and tests/. Not a release blocker for 1.5.4 since it's all internal.

lib/zstd.h Outdated Show resolved Hide resolved
lib/zstd.h Outdated Show resolved Hide resolved
lib/zstd.h Outdated Show resolved Hide resolved
@embg embg force-pushed the rename branch 3 times, most recently from fad2aad to 5436584 Compare February 9, 2023 16:32
@embg embg changed the title draft Rename the External Matchfinder API to Block-Level Sequence Producer API Feb 9, 2023
@embg embg changed the title Rename the External Matchfinder API to Block-Level Sequence Producer API Rename "External Matchfinder" to "Block-Level Sequence Producer" Feb 9, 2023
@embg embg force-pushed the rename branch 2 times, most recently from d42b227 to 824f412 Compare February 9, 2023 18:00
@embg embg marked this pull request as ready for review February 9, 2023 18:52
@embg embg requested a review from Cyan4973 February 9, 2023 20:10
@embg embg merged commit ff42ed1 into facebook:dev Feb 9, 2023
@embg embg deleted the rename branch February 9, 2023 22:01
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