From 6ba0a99017345444b90776fc85bcf33bcda71feb Mon Sep 17 00:00:00 2001 From: Steve Vaughan Jr Date: Tue, 17 Nov 2026 10:47:40 -0500 Subject: [PATCH] docs: tell backport authors to update the frozen compatibility pages A release branch commits the generated docs that main fills in at publish time. The backporting guide's list of easy-to-miss differences named only configs.md, but the per-Spark-version compatibility pages are frozen the same way. They render what an expression serde reports through getCompatibleNotes, getIncompatibleReasons and getUnsupportedReasons, and they hold the cast support tables. Add a bullet that says so, names what changes their content, and points at dev/generate-release-docs.sh for the exact text. The script rewrites every frozen page, so the bullet also tells the author to keep only the hunks the backport changes. --- docs/source/contributor-guide/backporting.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/contributor-guide/backporting.md b/docs/source/contributor-guide/backporting.md index dbeeb57885e..9d9fce3f988 100644 --- a/docs/source/contributor-guide/backporting.md +++ b/docs/source/contributor-guide/backporting.md @@ -124,6 +124,14 @@ Some differences between a release branch and `main` are easy to miss: rather than template markers (see [Generate Release Documentation](release_process.md#generate-release-documentation)). A backport that changes a configuration's description or default has to update its row there. +- The per-Spark-version compatibility pages in + `docs/source/user-guide/latest/compatibility/expressions/spark-/` are frozen the same + way. A backport that changes the notes or reasons an expression serde reports + (`getCompatibleNotes`, `getIncompatibleReasons` or `getUnsupportedReasons`), or the support level + of a cast, has to update the matching section in each page it affects. Rerunning + `./dev/generate-release-docs.sh` and reading `git diff` shows the exact text, at the cost of one + Maven build per Spark version. The script rewrites every frozen page, so keep only the hunks the + backport changes. - Only `docs/source/user-guide/latest/` is published from a release branch, so changes to the contributor guide or `docs/source/conf.py` need no backport. - CI builds with the latest stable Rust. When a new Rust release adds Clippy lints, `main` gets a