lucasfang opened a new pull request, #467: URL: https://github.com/apache/paimon-cpp/pull/467
### Purpose Linked issue: close #466 Correct statements the implementation contradicts and bring the feature, build-switch, plugin-target and system-table lists up to date. The substantive errors: `compaction.rst` documented `compaction.file-size`, an option that has never existed, and `parquet.enable-dictionary`, renamed to `parquet.enable.dictionary` in #263; `primary_key_global_index.rst` stated commit message v12, raised to 13 in #247; `write.rst` said object-store paths require REST catalog commit mode, although `table.cpp` also accepts `WithCatalog()`. The stale lists: README now covers primary-key commit and all seven registered formats instead of three, `building.rst` gains `PAIMON_ENABLE_MOSAIC`, `PAIMON_ENABLE_VORTEX` and `PAIMON_ENABLE_NETWORK_TESTS`, `build_system.rst` gains four plugin targets, `basic_concepts.rst` gains Vortex, which removes its contradiction with `data_types.rst`, and `system_tables.rst` goes from 4 documented suffixes to all 15. The coverage gaps: `api/catalog.rst` adds `Table`, `Data base` and `CatalogOptions`, `catalog.rst` documents the `Table::NewScan`, `NewRead`, `NewWrite` and `NewCommit` entry points added in #434 as equivalent to the `Create()` calls, and `code-style.md` adds the missing hooks, clang-tidy check groups and testing utilities. ### Tests No code changes, so no unit or integration test applies. Verified locally: `pre-commit run --files` over the eleven changed files passes, including Sphinx Lint, codespell and trailing-whitespace, and `git diff --check` is clean. Every correction was taken from the source rather than assumed: option names from `defs.cpp` and `parquet_format_defs.h`, the compaction threshold from `CoreOptions::GetCompactionFileSize()`, the commit-message version range from `CommitMessageSerializer::Deserialize`, the object-store commit modes from the guard in `table.cpp`, plugin targets from each `add_paimon_lib` call together with the `add_subdirectory` guards that establish which of them build unconditionally, system-table semantics from the class comments in `metadata_system_tables.h` and `global_system_tables.h`, and the testing-utility entries from the implementations themselves. The cross-reference and doxygen-target checks over `docs/source/` still resolve; the doxygen target count rises from 89 to 92 with the three added classes. ### API and Format No. Documentation only: nothing under `include/` changes and no storage format or protocol is affected. Two statements now record the current facts rather than change them: `CommitMessageSerializer` writes version 13 and reads versions 3 through 13, and an object-store commit accepts either `CommitContextBuilder::WithCatalog()` or `UseRESTCatalogCommit()`, the two being mutually exclusive. ### Documentation This change is itself the documentation work; it introduces no new feature. Eleven files: `README.md`, `docs/code-style.md`, `docs/source/basic_concepts.rst`, `docs/source/build_system.rst`, `docs/source/building.rst`, `docs/source/api/catalog.rst` and, under `docs/source/user_guide/`, `catalog.rst`, `compaction.rst`, `primary_key_global_index.rst`, `system_tables.rst` and `write.rst`. Two known gaps are deliberately left out because they need new prose rather than corrections: the realtime module has 16 exported types with no user guide or API page, and roughly thirty further exported classes that the user guide explains at length have no API reference page. ### Generative AI tooling Generated-by: Qoder -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
