Conversation
WalkthroughUpdated README documentation to expand feature descriptions with additional SIMD/intrinsics targets and architectures, reworked Build Options table with new entries, and revised Advanced Build Options section for unified architecture presentation. Changes
Possibly related PRs
Suggested labels
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
104-104: Fix British/American English spelling inconsistency.The documentation mixes British and American spelling of "optimisation/optimization":
- Line 104: Uses American "optimizations" (WITH_OPTIM configure option)
- Lines 212, 213, 219: Use British "optimisations" (WITH_POWER8, WITH_POWER9, WITH_LSX descriptions)
Standardize on one variant throughout the document for consistency.
Apply this diff to standardize on American English spelling:
-| WITH_POWER8 | --without-power8 | ppc: Build with POWER8 optimisations | ON | +| WITH_POWER8 | --without-power8 | ppc: Build with POWER8 optimizations | ON |-| WITH_POWER9 | --without-power9 | ppc: Build with POWER9 optimisations | ON | +| WITH_POWER9 | --without-power9 | ppc: Build with POWER9 optimizations | ON |-| WITH_LSX | | loongarch: Build with LSX optimisations | ON | +| WITH_LSX | | loongarch: Build with LSX optimizations | ON |Also applies to: 212-212, 213-213, 219-219
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-07-04T16:59:44.725Z
Learnt from: mtl1979
Repo: zlib-ng/zlib-ng PR: 1925
File: arch/loongarch/lasxintrin_ext.h:38-65
Timestamp: 2025-07-04T16:59:44.725Z
Learning: In zlib-ng, the policy for supporting old compilers is to maintain compatibility for up to two years after GitHub removes support for them in CI, or when there is no long-time contributor left testing for the architecture if the architecture was not supported by GitHub Actions at all.
Applied to files:
README.md
📚 Learning: 2025-02-21T01:41:50.358Z
Learnt from: KungFuJesus
Repo: zlib-ng/zlib-ng PR: 1872
File: arch/x86/chorba_sse2.c:14-24
Timestamp: 2025-02-21T01:41:50.358Z
Learning: In zlib-ng's SSE2 vectorized Chorba CRC implementation, the code that calls READ_NEXT macro ensures 16-byte alignment, making explicit alignment checks unnecessary within the macro.
Applied to files:
README.md
📚 Learning: 2025-10-12T17:01:13.630Z
Learnt from: mtl1979
Repo: zlib-ng/zlib-ng PR: 1980
File: compress.c:31-33
Timestamp: 2025-10-12T17:01:13.630Z
Learning: In zlib-ng, when ZLIB_COMPAT is defined, z_int32_t is typedef'd as `int` (not int32_t), and zlib.h is included (which uses `int` in function signatures). This allows the implementation to use z_int32_t while maintaining backwards compatibility with the original zlib API that uses `int`. When ZLIB_COMPAT is not defined, z_int32_t is typedef'd as int32_t and zlib-ng.h is used instead.
Applied to files:
README.md
🪛 LanguageTool
README.md
[uncategorized] ~104-~104: Do not mix variants of the same word (‘optimisation’ and ‘optimization’) within a single text.
Context: ...| --without-optimizations | Build with optimisations ...
(EN_WORD_COHERENCY)
[uncategorized] ~212-~212: Do not mix variants of the same word (‘optimisation’ and ‘optimization’) within a single text.
Context: ...ut-power8 | ppc: Build with POWER8 optimisations ...
(EN_WORD_COHERENCY)
[uncategorized] ~213-~213: Do not mix variants of the same word (‘optimisation’ and ‘optimization’) within a single text.
Context: ...ut-power9 | ppc: Build with POWER9 optimisations ...
(EN_WORD_COHERENCY)
[uncategorized] ~219-~219: Do not mix variants of the same word (‘optimisation’ and ‘optimization’) within a single text.
Context: ... | loongarch: Build with LSX optimisations ...
(EN_WORD_COHERENCY)
🔇 Additional comments (3)
README.md (3)
22-26: Enhanced feature descriptions are comprehensive and well-documented.The expanded SIMD target listings for Adler32, CRC32-B, slide hash, Compare256, and inflate chunk copying provide clear visibility into architecture-specific optimizations. This aligns well with the PR objective to document missing instruction set information.
109-109: Potential duplicate entry: Verify WITH_BENCHMARKS placement.
WITH_BENCHMARKSappears in the Build Options table (line 109) with description "Build benchmarks using Google Benchmark framework" and Default OFF. This same option also appears in the Advanced Build Options table (line 223) with slightly different description. Verify this is intentional and not a documentation error.
195-228: Advanced Build Options table reorganization is well-structured.The refactored table with unified architecture-specific grouping (x86:, arm:, ppc:, riscv:, s390x:, loongarch:) significantly improves readability and maintainability. All options are clearly documented with defaults specified. This reorganization effectively addresses the PR objective to present architecture options in a unified manner.
2e98ecb to
0592620
Compare
Add missing parameter to configure help text. Update descriptions and reorganize some options in CMake
| echo ' [--without-zbc] Compiles without RISC-V ZBC instruction set' | tee -a configure.log | ||
| echo ' [--without-altivec] Compiles without PPC AltiVec support' | tee -a configure.log | ||
| echo ' [--without-power8] Compiles without Power8 instruction set' | tee -a configure.log | ||
| echo ' [--without-power9] Compiles without Power9 instruction set' | tee -a configure.log |
There was a problem hiding this comment.
Wow, I'm surprised this is missing, we had power9 for long time!
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## develop #2000 +/- ##
===========================================
- Coverage 83.31% 75.40% -7.91%
===========================================
Files 161 161
Lines 12960 14187 +1227
Branches 3149 3802 +653
===========================================
- Hits 10797 10698 -99
- Misses 1133 2320 +1187
- Partials 1030 1169 +139 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Add missing instruction set info.
Add missing configuration options and update some descriptions.
Reorganize some configuration options.