Document format for SetSpanParent

[gm42]

SetSpanParent does not take a 16-bytes trace id as documentation mentions, but rather requires a specific serialized binary format (described in description field).

I would merge this to the release-7.3 release branch as well.

Code-Reviewer Section

The general pull request guidelines can be found here.

Please check each of the following things and check all boxes before accepting a PR.

• [x] The PR has a description, explaining both the problem and the solution.
• [ ] The description mentions which forms of testing were done and the testing seems reasonable.
• [ ] Every function/class/actor that was touched is reasonably well documented.

For Release-Branches

If this PR is made against a release-branch, please also check the following:

• [ ] This change/bugfix is a cherry-pick from the next younger branch (younger release-branch or main if this is the youngest branch)
• [ ] There is a good reason why this PR needs to go into a release branch and this reason is documented (either in the description above or in a linked GitHub issue)

[foundationdb-ci]

Result of foundationdb-pr-macos-m1 on macOS Ventura 13.x

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:05:41
• Result: :x: FAILED
• Error: Error while executing command: ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i ${HOME}/.ssh_key ec2-user@${MAC_EC2_HOST} /opt/homebrew/bin/bash --login -c ./build_pr_macos.sh. Reason: exit status 1
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-clang-ide on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:05:54
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-clang on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:06:29
• Result: :x: FAILED
• Error: Error while executing command: python3 -m joshua.joshua start --tarball $(find build_output/packages -name correctness\*.tar.gz) --username ${CORRECTNESS_USERNAME} --max-runs 10000. Reason: exit status 2
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-cluster-tests on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:07:23
• Result: :x: FAILED
• Error: Error while executing command: mvn install:install-file --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -Dfile=packages/fdb-java-${FDB_VERSION}-SNAPSHOT.jar -DgroupId=org.foundationdb -DartifactId=fdb-java -Dversion=${FDB_VERSION}-SNAPSHOT -Dpackaging=jar -DgeneratePom=true. Reason: exit status 1
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)
• Cluster Test Logs zip file of the test logs (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:07:32
• Result: :x: FAILED
• Error: Error while executing command: python3 -m joshua.joshua start --tarball $(find build_output/packages -name correctness\*.tar.gz) --username ${CORRECTNESS_USERNAME} --max-runs 10000. Reason: exit status 2
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-macos on macOS Ventura 13.x

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:08:47
• Result: :x: FAILED
• Error: Error while executing command: ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i ${HOME}/.ssh_key ec2-user@${MAC_EC2_HOST} /usr/local/bin/bash --login -c ./build_pr_macos.sh. Reason: exit status 1
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-clang-ide on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:07:46
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-cluster-tests on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:08:25
• Result: :x: FAILED
• Error: Error while executing command: mvn install:install-file --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -Dfile=packages/fdb-java-${FDB_VERSION}-SNAPSHOT.jar -DgroupId=org.foundationdb -DartifactId=fdb-java -Dversion=${FDB_VERSION}-SNAPSHOT -Dpackaging=jar -DgeneratePom=true. Reason: exit status 1
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)
• Cluster Test Logs zip file of the test logs (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-clang on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:08:31
• Result: :x: FAILED
• Error: Error while executing command: python3 -m joshua.joshua start --tarball $(find build_output/packages -name correctness\*.tar.gz) --username ${CORRECTNESS_USERNAME} --max-runs 10000. Reason: exit status 2
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr on Linux CentOS 7

• Commit ID: b7e5f70238353a6fdaccd47b16be5964296b767d
• Duration 0:08:44
• Result: :x: FAILED
• Error: Error while executing command: python3 -m joshua.joshua start --tarball $(find build_output/packages -name correctness\*.tar.gz) --username ${CORRECTNESS_USERNAME} --max-runs 10000. Reason: exit status 2
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[jzhou77]

Looks like compilation failed:

[284/1833] cd /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient && /usr/bin/mono /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/vexillographer.exe /codebuild/output/src4202394945/src/github.com/apple/foundationdb/fdbclient/vexillographer/fdb.options cpp /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient/FDBOptions.g
FAILED: fdbclient/FDBOptions.g.h fdbclient/FDBOptions.g.cpp /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient/FDBOptions.g.h /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient/FDBOptions.g.cpp 
cd /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient && /usr/bin/mono /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/vexillographer.exe /codebuild/output/src4202394945/src/github.com/apple/foundationdb/fdbclient/vexillographer/fdb.options cpp /codebuild/output/src4202394945/src/github.com/apple/foundationdb/build_output/fdbclient/FDBOptions.g

Unhandled Exception:
System.FormatException: Index (zero based) must be greater than or equal to zero and less than the size of the argument list.
  at System.Text.StringBuilder.AppendFormatHelper (System.IFormatProvider provider, System.String format, System.ParamsArray args) [0x000f9] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.String.FormatHelper (System.IFormatProvider provider, System.String format, System.ParamsArray args) [0x00023] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.String.Format (System.IFormatProvider provider, System.String format, System.Object arg0) [0x00008] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.IO.TextWriter.WriteLine (System.String format, System.Object arg0) [0x00007] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at vexillographer.cpp.writeCppInfo (System.IO.TextWriter outFile, vexillographer.Scope scope, System.Collections.Generic.IEnumerable`1[T] options) [0x00076] in <b399b67bcaa449f0b71171d5ab3c5236>:0 
  at vexillographer.cpp.writeFiles (System.String fileName, System.Collections.Generic.IEnumerable`1[T] options) [0x0018d] in <b399b67bcaa449f0b71171d5ab3c5236>:0 
  at vexillographer.vexillographer.Main (System.String[] args) [0x00082] in <b399b67bcaa449f0b71171d5ab3c5236>:0 
[ERROR] FATAL UNHANDLED EXCEPTION: System.FormatException: Index (zero based) must be greater than or equal to zero and less than the size of the argument list.
  at System.Text.StringBuilder.AppendFormatHelper (System.IFormatProvider provider, System.String format, System.ParamsArray args) [0x000f9] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.String.FormatHelper (System.IFormatProvider provider, System.String format, System.ParamsArray args) [0x00023] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.String.Format (System.IFormatProvider provider, System.String format, System.Object arg0) [0x00008] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at System.IO.TextWriter.WriteLine (System.String format, System.Object arg0) [0x00007] in <5dfd69ae4e3b402db546d8ded6fc755e>:0 
  at vexillographer.cpp.writeCppInfo (System.IO.TextWriter outFile, vexillographer.Scope scope, System.Collections.Generic.IEnumerable`1[T] options) [0x00076] in <b399b67bcaa449f0b71171d5ab3c5236>:0 
  at vexillographer.cpp.writeFiles (System.String fileName, System.Collections.Generic.IEnumerable`1[T] options) [0x0018d] in <b399b67bcaa449f0b71171d5ab3c5236>:0 
  at vexillographer.vexillographer.Main (System.String[] args) [0x00082] in <b399b67bcaa449f0b71171d5ab3c5236>:0 

[gm42]

It looks like {...} is an expression used for formatting, will remove it.

Edit: done.

[foundationdb-ci]

Result of foundationdb-pr-clang-ide on Linux CentOS 7

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:21:37
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-macos-m1 on macOS Ventura 13.x

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:34:32
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-macos on macOS Ventura 13.x

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:47:06
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-clang on Linux CentOS 7

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:54:15
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr on Linux CentOS 7

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:54:31
• Result: :x: FAILED
• Error: Error while executing command: if python3 -m joshua.joshua list --stopped | grep ${ENSEMBLE_ID} | grep -q 'pass=10[0-9][0-9][0-9]'; then echo PASS; else echo FAIL && exit 1; fi. Reason: exit status 1
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)

[foundationdb-ci]

Result of foundationdb-pr-cluster-tests on Linux CentOS 7

• Commit ID: 12bcc48d77ed3fe531940cb4d64168de882bf119
• Duration 0:55:54
• Result: :white_check_mark: SUCCEEDED
• Error: N/A
• Build Log terminal output (available for 30 days)
• Build Workspace zip file of the working directory (available for 30 days)
• Cluster Test Logs zip file of the test logs (available for 30 days)