From c283017b5e0c08ab18ed4637211ff5a6b12c1aa7 Mon Sep 17 00:00:00 2001
From: zhan7236 <76658920+zhan7236@users.noreply.github.com>
Date: Thu, 27 Nov 2025 09:00:52 +0000
Subject: [PATCH] Improve linkage check script documentation for git references

The usage documentation previously showed 'origin/master' as an example,
which incorrectly suggested that users must have a remote called 'origin'.
The script actually accepts any valid git reference.

This change clarifies the documentation by:
- Using generic '<baseline ref>' placeholder instead of 'origin/master'
- Adding examples of valid git references (remote branches, local branches,
  commit SHAs, and tags)

Fixes #20650
---
 sdks/java/build-tools/beam-linkage-check.sh | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/sdks/java/build-tools/beam-linkage-check.sh b/sdks/java/build-tools/beam-linkage-check.sh
index 69d25dad15e6..8863c7bb1df5 100755
--- a/sdks/java/build-tools/beam-linkage-check.sh
+++ b/sdks/java/build-tools/beam-linkage-check.sh
@@ -20,7 +20,13 @@
 # one branch and another.
 
 # Usage:
-#  /bin/bash sdks/java/build-tools/beam-linkage-check.sh origin/master <your branch>
+#  /bin/bash sdks/java/build-tools/beam-linkage-check.sh <baseline ref> <proposed ref>
+#
+#  The <baseline ref> and <proposed ref> can be any valid git reference such as:
+#  - A remote branch: origin/master, upstream/main
+#  - A local branch: master, my-feature-branch
+#  - A commit SHA: abc123def
+#  - A tag: v2.50.0
 #
 #  By default, this checks the Maven artifacts listed in ARTIFACTS variable below.
 #