summaryrefslogtreecommitdiff
path: root/lib/bundler/man
diff options
context:
space:
mode:
authorDavid Rodríguez <[email protected]>2024-12-10 19:16:18 +0100
committergit <[email protected]>2024-12-11 17:56:24 +0000
commitf5ed1b56d017b8a7d67d4dd0b1d1e1a0856ac5d9 (patch)
tree0a3f582067e3468c9af8adeee892901cecfdd52c /lib/bundler/man
parent443319de3542a21e7aa2603ff0f0d46759db6089 (diff)
[rubygems/rubygems] Add several missing flags to `bundle gem --help`
https://github.com/rubygems/rubygems/commit/aaf6398870
Diffstat (limited to 'lib/bundler/man')
-rw-r--r--lib/bundler/man/bundle-gem.18
-rw-r--r--lib/bundler/man/bundle-gem.1.ronn12
2 files changed, 20 insertions, 0 deletions
diff --git a/lib/bundler/man/bundle-gem.1 b/lib/bundler/man/bundle-gem.1
index f8b2cda7c8..346160a0e4 100644
--- a/lib/bundler/man/bundle-gem.1
+++ b/lib/bundler/man/bundle-gem.1
@@ -32,6 +32,10 @@ The generated project skeleton can be customized with OPTIONS, as explained belo
.IP "\(bu" 4
\fB\-\-no\-ext\fR: Do not add extension code (overrides \fB\-\-ext\fR specified in the global config)\.
.IP "\(bu" 4
+\fB\-\-git\fR: Initialize a git repo inside your library\.
+.IP "\(bu" 4
+\fB\-\-github\-username=GITHUB_USERNAME\fR: Fill in GitHub username on README so that you don't have to do it manually\. Set a default with \fBbundle config set \-\-global gem\.github_username <your_username>\fR\.
+.IP "\(bu" 4
\fB\-\-mit\fR: Add an MIT license to a \fBLICENSE\.txt\fR file in the root of the generated project\. Your name from the global git config is used for the copyright statement\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-mit\fR: Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the global config)\.
@@ -46,6 +50,8 @@ When Bundler is unconfigured, an interactive prompt will be displayed and the an
.IP "\(bu" 4
\fB\-\-no\-test\fR: Do not use a test framework (overrides \fB\-\-test\fR specified in the global config)\.
.IP "\(bu" 4
+\fB\-\-changelog\fR: Generate changelog file\. Set a default with \fBbundle config set \-\-global gem\.changelog true\fR\.
+.IP "\(bu" 4
\fB\-\-ci\fR, \fB\-\-ci=github\fR, \fB\-\-ci=gitlab\fR, \fB\-\-ci=circle\fR: Specify the continuous integration service that Bundler should use when generating the project\. Acceptable values are \fBgithub\fR, \fBgitlab\fR and \fBcircle\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to generate CI files, this defaults to Bundler's global config setting \fBgem\.ci\fR\.
@@ -66,6 +72,8 @@ When Bundler is unconfigured, an interactive prompt will be displayed and the an
.IP "\(bu" 4
\fB\-\-no\-linter\fR: Do not add a linter (overrides \fB\-\-linter\fR specified in the global config)\.
.IP "\(bu" 4
+\fB\-\-rubocop\fR: Add rubocop to the generated Rakefile and gemspec\. Set a default with \fBbundle config set \-\-global gem\.rubocop true\fR\.
+.IP "\(bu" 4
\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR: Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
.IP "" 0
.SH "SEE ALSO"
diff --git a/lib/bundler/man/bundle-gem.1.ronn b/lib/bundler/man/bundle-gem.1.ronn
index a0820b497e..f81c31f710 100644
--- a/lib/bundler/man/bundle-gem.1.ronn
+++ b/lib/bundler/man/bundle-gem.1.ronn
@@ -49,6 +49,12 @@ configuration file using the following names:
Do not add extension code (overrides `--ext` specified in the global
config).
+* `--git`:
+ Initialize a git repo inside your library.
+
+* `--github-username=GITHUB_USERNAME`:
+ Fill in GitHub username on README so that you don't have to do it manually. Set a default with `bundle config set --global gem.github_username <your_username>`.
+
* `--mit`:
Add an MIT license to a `LICENSE.txt` file in the root of the generated
project. Your name from the global git config is used for the copyright
@@ -80,6 +86,9 @@ configuration file using the following names:
Do not use a test framework (overrides `--test` specified in the global
config).
+* `--changelog`:
+ Generate changelog file. Set a default with `bundle config set --global gem.changelog true`.
+
* `--ci`, `--ci=github`, `--ci=gitlab`, `--ci=circle`:
Specify the continuous integration service that Bundler should use when
generating the project. Acceptable values are `github`, `gitlab`
@@ -119,6 +128,9 @@ configuration file using the following names:
* `--no-linter`:
Do not add a linter (overrides `--linter` specified in the global config).
+* `--rubocop`:
+ Add rubocop to the generated Rakefile and gemspec. Set a default with `bundle config set --global gem.rubocop true`.
+
* `-e`, `--edit[=EDITOR]`:
Open the resulting GEM_NAME.gemspec in EDITOR, or the default editor if not
specified. The default is `$BUNDLER_EDITOR`, `$VISUAL`, or `$EDITOR`.