docs: rewrite README to match wrapper documentation standard#60
docs: rewrite README to match wrapper documentation standard#60sayalibhavsar wants to merge 1 commit into
Conversation
|
Warning Review limit reached
More reviews will be available in 4 minutes and 18 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthroughREADME.md is substantially rewritten from a minimal description into comprehensive documentation. It adds a full CLI options reference, an 11-step workflow walkthrough, dependency and Java package requirements, benchmark background, output file descriptions, multiple example invocations, warehouse and JVM sizing logic, return codes, and expanded notes with troubleshooting guidance. ChangesSPECjbb2005 Wrapper README Rewrite
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 297-314: The warehouse-sizing formulas in the documentation can
produce fractional results from division operations like `end_warehouse / 8` and
the derived `start` calculation `(end_warehouse - (increment * 8)) + increment`,
but warehouse counts must be integral values. Update the documentation to
explicitly specify the rounding behavior applied to these formulas (floor,
ceiling, or standard rounding), clarifying how fractional results are handled.
Apply this clarification consistently to all three sections covering Ending
Warehouse Count, Starting Warehouse Count, and Increment, ensuring readers
understand that the final warehouse values are always integers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
sayalibhavsar
changed the title
Comprehensive rewrite of the specjbb-wrapper README modeled after the autohpl-wrapper documentation structure. All content is derived from the specjbb-wrapper source code. Adds detailed sections for: command-line options (including all general_setup options), step-by-step workflow, dependencies with per-OS Java package matrix, benchmark explanation, output files, usage examples, warehouse sizing logic, JVM heap sizing, return codes, and troubleshooting notes. Removes stale pbench references from the original documentation.
sayalibhavsar
force-pushed
the
docs/rewrite-readme
branch
from
17f6eb5 to
b309f2a
Compare
1 participant
Summary
general_setupoptions (--debug,--no_pkg_install,--no_system_packages,--no_pip_packages,--run_label,--test_tools_release,--verify_skip,--json_skip)New sections added
reduce_jbb.shutility, performance tips, troubleshootingSolves #59
Relates to JIRA: RPOPC-937