This is an automated email from the ASF dual-hosted git repository.
tisonkun pushed a commit to branch codex/atomic-snapshot-updates
in repository https://gitbox.apache.org/repos/asf/datasketches-tck.git
The following commit(s) were added to refs/heads/codex/atomic-snapshot-updates
by this push:
new 4586735 docs: prioritize common snapshot workflows
4586735 is described below
commit 4586735251626c5fca9bc0a70c93a86e679465b6
Author: tison <[email protected]>
AuthorDate: Tue Sep 1 09:22:43 2026 +0800
docs: prioritize common snapshot workflows
Signed-off-by: tison <[email protected]>
---
docs/serialization-snapshots.md | 48 ++++++++++++++++++++---------------------
1 file changed, 24 insertions(+), 24 deletions(-)
diff --git a/docs/serialization-snapshots.md b/docs/serialization-snapshots.md
index 9c9ccde..95b1af9 100644
--- a/docs/serialization-snapshots.md
+++ b/docs/serialization-snapshots.md
@@ -27,32 +27,9 @@ repository = "https://github.com/apache/datasketches-go.git";
commit = "730c0ca31e00b8becf8b70591ae8ca73954912d0"
```
-## Set up the toolchain
-
-Install [mise](https://mise.jdx.dev/), then install the pinned toolchain and
inspect the available snapshot commands:
-
-```shell
-mise install
-mise run tck -- snapshots --help
-```
-
-Mise supplies Go, CMake and CTest, Java, and Maven. Git is required for every
source language, a C++ compiler is required for C++, and Make is required for
Go.
-
-Check mode accepts `cpp`, `go`, `java`, or `all`. The synchronization and
update commands below have narrower inputs.
-
-## Synchronize configured snapshots
-
-Regenerate every snapshot directory from the repositories and commits
currently recorded in `config.toml`:
-
-```shell
-mise run tck -- snapshots sync
-```
-
-Sync may change the committed snapshot directories, but it never changes
`config.toml`.
-
## Update one source
-To adopt a different upstream branch, tag, or commit, specify one source
language and revision:
+With the [toolchain installed](#set-up-the-toolchain), adopt a different
upstream branch, tag, or commit by specifying one source language and revision:
```shell
mise run tck -- snapshots update go main
@@ -92,6 +69,29 @@ Check mode does not modify the repository. It fails for
added or deleted files a
This command answers whether the repository matches its pin; it does not
determine whether the pin is the latest upstream commit.
+## Synchronize configured snapshots
+
+Regenerate every snapshot directory from the repositories and commits
currently recorded in `config.toml`:
+
+```shell
+mise run tck -- snapshots sync
+```
+
+Sync may change the committed snapshot directories, but it never changes
`config.toml`.
+
+## Set up the toolchain
+
+Install [mise](https://mise.jdx.dev/), then install the pinned toolchain and
inspect the available snapshot commands:
+
+```shell
+mise install
+mise run tck -- snapshots --help
+```
+
+Mise supplies Go, CMake and CTest, Java, and Maven. Git is required for every
source language, a C++ compiler is required for C++, and Make is required for
Go.
+
+Check mode accepts `cpp`, `go`, `java`, or `all`. Synchronization takes no
arguments, while update requires one source language and revision.
+
## Use the corpus from an implementation
An implementation consumes the `.sk` files as test fixtures. Its compatibility
tests should load snapshots produced by the other source languages, deserialize
each supported sketch family, and assert observable results with tolerances
appropriate to that algorithm.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
