Skip to content

docs: explain how to identify JBang applications in VisualVM - #2697

Open
gelatoni-xh wants to merge 2 commits into
jbangdev:mainfrom
gelatoni-xh:docs/2639-visualvm-display-name
Open

gelatoni-xh wants to merge 2 commits into
jbangdev:mainfrom
gelatoni-xh:docs/2639-visualvm-display-name

Conversation

@gelatoni-xh

@gelatoni-xh gelatoni-xh commented Nov 2, 2026 •

Copy link
Copy Markdown

Add a VisualVM section to the Running guide, next to the existing JVM diagnostics guidance. It shows how to pass visualvm.display.name with jbang run to identify the application, and notes that the same option works for JAR files.

Refs #2639.

Validation:

  • Ran the example with JBang 0.143.0 on macOS x86_64 / Java 8u261 using both Java source and an exported JAR; both received the expected property. Confirmed the target JVM argument with jcmd.
  • Rendered the modified Running page using Asciidoctor.js 4.1.1 with no warnings and checked the new VisualVM website link.
  • git diff --check passes.

The VisualVM GUI display and full Antora site build have not been verified. This is a documentation-only change; the full Java build/test suite was not run.

Prepared with AI assistance; reviewed and approved for submission by the contributor.

Summary by CodeRabbit

  • Documentation
    • Added VisualVM guidance for setting an application’s display name when launching it with JBang, so it can be identified in the Local applications list. The guide includes the visualvm.display.name option and explains how to apply it when launching either Java source files or JAR files.

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between ae619f4 and 34dee84.

Files selected for processing: 1
  • docs/modules/ROOT/pages/running.adoc
Files skipped from review as they are similar to previous changes: 1
  • docs/modules/ROOT/pages/running.adoc

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Walkthrough

The running guide adds instructions for setting visualvm.display.name when launching a Java application or JAR file with JBang. It explains where to find the named application in VisualVM.

Changes: VisualVM documentation

Layer / File(s) Summary
Document VisualVM launch instructions
docs/modules/ROOT/pages/running.adoc
The guide describes setting visualvm.display.name at launch and finding the named application under VisualVM’s Local Applications. It also explains how to apply the option to a JAR file.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to 34dee

The guide explains how to name a JBang application for VisualVM. No actionable issue remains before merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation change: explaining how to identify JBang applications in VisualVM.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread docs/modules/ROOT/pages/running.adoc Resolved

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant