[rubygems/rubygems] Add man page for 'bundle issue' command
https://github.com/rubygems/rubygems/commit/3f39571181
This commit is contained in:
parent
51bf0d4d68
commit
b4969348bf
45
lib/bundler/man/bundle-issue.1
Normal file
45
lib/bundler/man/bundle-issue.1
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
.\" generated with nRonn/v0.11.1
|
||||||
|
.\" https://github.com/n-ronn/nronn/tree/0.11.1
|
||||||
|
.TH "BUNDLE\-ISSUE" "1" "November 2024" ""
|
||||||
|
.SH "NAME"
|
||||||
|
\fBbundle\-issue\fR \- Get help reporting Bundler issues
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
\fBbundle issue\fR
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
Provides guidance on reporting Bundler issues and outputs detailed system information that should be included when filing a bug report\. This command:
|
||||||
|
.IP "1." 4
|
||||||
|
Displays links to troubleshooting resources
|
||||||
|
.IP "2." 4
|
||||||
|
Shows instructions for reporting issues
|
||||||
|
.IP "3." 4
|
||||||
|
Outputs comprehensive environment information needed for debugging
|
||||||
|
.IP "" 0
|
||||||
|
.P
|
||||||
|
The command helps ensure that bug reports include all necessary system details for effective troubleshooting\.
|
||||||
|
.SH "OUTPUT"
|
||||||
|
The command outputs several sections:
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Troubleshooting links and resources
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Link to the GitHub issue template
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Environment information including: Bundler version and platforms, Ruby version and configuration, RubyGems version and paths, Development tool versions (Git, RVM, rbenv, chruby)
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Bundler build metadata
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Current Bundler settings
|
||||||
|
.IP "\(bu" 4
|
||||||
|
Bundle Doctor output
|
||||||
|
.IP "" 0
|
||||||
|
.SH "EXAMPLES"
|
||||||
|
Get issue reporting information:
|
||||||
|
.IP "" 4
|
||||||
|
.nf
|
||||||
|
$ bundle issue
|
||||||
|
.fi
|
||||||
|
.IP "" 0
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.IP "\(bu" 4
|
||||||
|
bundle\-doctor(1)
|
||||||
|
.IP "" 0
|
||||||
|
|
37
lib/bundler/man/bundle-issue.1.ronn
Normal file
37
lib/bundler/man/bundle-issue.1.ronn
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
bundle-issue(1) -- Get help reporting Bundler issues
|
||||||
|
=====================================================
|
||||||
|
|
||||||
|
## SYNOPSIS
|
||||||
|
|
||||||
|
`bundle issue`
|
||||||
|
|
||||||
|
## DESCRIPTION
|
||||||
|
|
||||||
|
Provides guidance on reporting Bundler issues and outputs detailed system information that should be included when filing a bug report. This command:
|
||||||
|
|
||||||
|
1. Displays links to troubleshooting resources
|
||||||
|
2. Shows instructions for reporting issues
|
||||||
|
3. Outputs comprehensive environment information needed for debugging
|
||||||
|
|
||||||
|
The command helps ensure that bug reports include all necessary system details for effective troubleshooting.
|
||||||
|
|
||||||
|
## OUTPUT
|
||||||
|
|
||||||
|
The command outputs several sections:
|
||||||
|
|
||||||
|
* Troubleshooting links and resources
|
||||||
|
* Link to the GitHub issue template
|
||||||
|
* Environment information including: Bundler version and platforms, Ruby version and configuration, RubyGems version and paths, Development tool versions (Git, RVM, rbenv, chruby)
|
||||||
|
* Bundler build metadata
|
||||||
|
* Current Bundler settings
|
||||||
|
* Bundle Doctor output
|
||||||
|
|
||||||
|
## EXAMPLES
|
||||||
|
|
||||||
|
Get issue reporting information:
|
||||||
|
|
||||||
|
$ bundle issue
|
||||||
|
|
||||||
|
## SEE ALSO
|
||||||
|
|
||||||
|
* bundle-doctor(1)
|
@ -16,6 +16,7 @@ bundle-info(1) bundle-info.1
|
|||||||
bundle-init(1) bundle-init.1
|
bundle-init(1) bundle-init.1
|
||||||
bundle-inject(1) bundle-inject.1
|
bundle-inject(1) bundle-inject.1
|
||||||
bundle-install(1) bundle-install.1
|
bundle-install(1) bundle-install.1
|
||||||
|
bundle-issue(1) bundle-issue.1
|
||||||
bundle-list(1) bundle-list.1
|
bundle-list(1) bundle-list.1
|
||||||
bundle-lock(1) bundle-lock.1
|
bundle-lock(1) bundle-lock.1
|
||||||
bundle-open(1) bundle-open.1
|
bundle-open(1) bundle-open.1
|
||||||
|
@ -29,11 +29,6 @@ RSpec.describe "bundle help" do
|
|||||||
expect(out).to match(/bundle-install/)
|
expect(out).to match(/bundle-install/)
|
||||||
end
|
end
|
||||||
|
|
||||||
it "still outputs the old help for commands that do not have man pages yet" do
|
|
||||||
bundle "help issue"
|
|
||||||
expect(out).to include("Learn how to report an issue in Bundler")
|
|
||||||
end
|
|
||||||
|
|
||||||
it "looks for a binary and executes it with --help option if it's named bundler-<task>" do
|
it "looks for a binary and executes it with --help option if it's named bundler-<task>" do
|
||||||
skip "Could not find command testtasks, probably because not a windows friendly executable" if Gem.win_platform?
|
skip "Could not find command testtasks, probably because not a windows friendly executable" if Gem.win_platform?
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user