about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-07 17:17:19 +0000
committerPjotr <wrk@bosa.lan>2026-11-07 17:17:19 +0000
commit2307d5e2db5ce8efae19a647bd48b4311be34607 (patch)
treeaefc0a48a38cd69fd0f38f8c163ad77ad8d8317a /docs
parent9fa03035b9f21352c1c8b93681cc1bc1ce4cf6ff (diff)
downloadgenenetwork4-2307d5e2db5ce8efae19a647bd48b4311be34607.tar.gz
version: document the provenance fields, and assert they agree
* README.md (/version): the example carries dirty/source_digest/branch,
and the prose says why a stamp can lag a commit -- a binary built from a
dirty tree must not claim that commit -- and that build.rs re-stamps on
a commit because it watches the ref, not just .git/HEAD.
* docs/www/ai-instruction.md: comparing against a clone means comparing
the part before "-dirty", with source_digest for the exact build.
* tests/version.rs: `dirty` mirrors the suffix, branch is non-empty, and
source_digest is 16 hex digits or unknown.
Diffstat (limited to 'docs')
-rw-r--r--docs/www/ai-instruction.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/www/ai-instruction.md b/docs/www/ai-instruction.md
index bb71a98..b1b2586 100644
--- a/docs/www/ai-instruction.md
+++ b/docs/www/ai-instruction.md
@@ -47,10 +47,13 @@ as HTML mentioning Anubis, stop — do not retry, and use the copy of this
 document you were given.
 
 To check you and the server are looking at the same revision, compare
-the clone's `git -C genenetwork4 log -1 --format=%h` with the `git` field of
-`GET /gn4/version`; they need not match exactly (docs can be newer than
-the running build), but a large gap means the API may not have what the
-docs describe.
+the clone's `git -C genenetwork4 log -1 --format=%h` with the `git` field
+of `GET /gn4/version`; they need not match exactly (docs can be newer
+than the running build), but a large gap means the API may not have what
+the docs describe. A `git` value ending in `-dirty` means that binary was
+built from a working tree with uncommitted changes: compare the part
+before `-dirty`, and quote `source_digest` if you need to identify the
+exact build.
 
 ```
 1. You are given a token     → by the GeneNetwork team, out of band