Update README

[xiexiaoy]

Summary by CodeRabbit

• Documentation

  • Clarified setup steps with $HOME-based extraction paths.
  • Added examples to change directory and list extracted contents.
  • Minor wording and formatting improvements for clearer verification instructions.

• Chores

  • Updated internal module configurations to latest revisions.
  • Bumped a submodule to a newer commit for alignment with upstream changes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Updates documentation paths and commands in README. Adds coroutine state assertions and resets in kill_sessions_local.cpp. Bumps two private module hashes. Advances eloq store_handler submodule pointer. Introduces a new method, a method signature change, and a variable rename in src/calculator.py.

Changes

Cohort / File(s)	Summary
Docs updates README.md	Edited instructions: switched to $HOME-based extraction paths, added cd/ls example, tweaked phrasing, minor formatting.
MongoDB session handling src/mongo/db/kill_sessions_local.cpp	After releasing client: assert coroutine state is Unavailable; before restoring client post-wait: explicitly set coroutine state to Unavailable.
Private modules config .private_modules	Updated hashes for raft_host_manager and log_service entries; keys unchanged.
Submodule bump (eloq store_handler) src/mongo/db/modules/eloq/store_handler	Advanced submodule pointer from e0e4ef0… to 6c5604a…; no interface changes noted.
Calculator changes src/calculator.py	Added Calculator.coderabbit_add(x, y); updated coderabbit_formula signature to (x, y, z); renamed global var from old_global_var to new_global_var.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Killer as PerSessionTxnKiller
  participant Client as Client
  participant Waiter as WaitRoutine

  Killer->>Client: release()
  Note right of Client: Assert coroutine state == Unavailable
  Killer->>Waiter: waitForKillCompletion()
  Waiter-->>Killer: done
  Killer->>Client: setCoroutineState(Unavailable)
  Killer->>Client: restore()

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• update submodules #206 — Updates the same eloq submodule (log_service) pointer.
• update subm #189 — Modifies the same submodule pointer for src/mongo/db/modules/eloq/store_handler.

Suggested labels

trigger-ci

Suggested reviewers

• lzxddz
• thweetkomputer

Poem

I hop through commits with delicate care,
Nudging clients to states they must wear.
HOME-bound tarballs neatly unpacked,
Submodules aligned, their hashes exact.
With add and formula, math feels right—
Thump-thump goes CI into the night. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Update README" is concise and accurately describes the README edits in the changeset, but the PR also contains a code change in src/mongo/db/kill_sessions_local.cpp and several submodule pointer updates, so the title only partially represents the full changeset; it nevertheless refers to a real part of the change and is not misleading.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aea50d4 and be9713f.

📒 Files selected for processing (4)

• .private_modules (1 hunks)
• README.md (2 hunks)
• src/mongo/db/kill_sessions_local.cpp (2 hunks)
• src/mongo/db/modules/eloq/store_handler (1 hunks)

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

README.md (2)

77-81: Tighten the instruction phrasing.

Consider a slightly clearer directive.

-`bin` contains all executable files, `lib` contains all dependencies, and `etc` contains an example configuration file `mongod.conf`. Switch to `eloqdoc-rocksdb` to verify that.
+`bin` contains executables, `lib` contains dependencies, and `etc` contains an example `mongod.conf`. Switch into `eloqdoc-rocksdb` and list files to verify.

---

129-130: Be idempotent and explicit with tar flags.

Using -p avoids errors if rerun; adding -z makes gzip explicit.

-mkdir $HOME/eloqdoc-rocksdbcloud && tar -xf eloqdoc-debug-ubuntu22-amd64.tar.gz -C $HOME/eloqdoc-rocksdbcloud
+mkdir -p "$HOME/eloqdoc-rocksdbcloud" && tar -xzf eloqdoc-debug-ubuntu22-amd64.tar.gz -C "$HOME/eloqdoc-rocksdbcloud"

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea4592d and e39dd3d.

📒 Files selected for processing (1)

• README.md (2 hunks)