Skip to content

Commit 99100aa

Browse files
authored
Improve linkage check script documentation for git references (#36925)
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
1 parent 9a0a343 commit 99100aa

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

sdks/java/build-tools/beam-linkage-check.sh

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
# one branch and another.
2121

2222
# Usage:
23-
# /bin/bash sdks/java/build-tools/beam-linkage-check.sh origin/master <your branch>
23+
# /bin/bash sdks/java/build-tools/beam-linkage-check.sh <baseline ref> <proposed ref>
24+
#
25+
# The <baseline ref> and <proposed ref> can be any valid git reference such as:
26+
# - A remote branch: origin/master, upstream/main
27+
# - A local branch: master, my-feature-branch
28+
# - A commit SHA: abc123def
29+
# - A tag: v2.50.0
2430
#
2531
# By default, this checks the Maven artifacts listed in ARTIFACTS variable below.
2632
#

0 commit comments

Comments
 (0)