Skip to content

Commit 92f7767

Browse files
addersukdeivid-rodriguez
authored andcommitted
Add documentation for changelog flags in bundle gem
The --changelog and --no-changelog flags are missing from docs, this adds them in a way that matches other flags
1 parent 21335a7 commit 92f7767

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

bundler/lib/bundler/man/bundle-gem.1

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ The generated project skeleton can be customized with OPTIONS, as explained belo
2828
.IP "\(bu" 4
2929
\fB\-\-no\-coc\fR: Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\.
3030
.IP "\(bu" 4
31+
\fB\-\-changelog\fR Add a \fBCHANGELOG\.md\fR file to the root of the generated project\. 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\.
32+
.IP "\(bu" 4
33+
\fB\-\-no\-changelog\fR: Do not create a \fBCHANGELOG\.md\fR (overrides \fB\-\-changelog\fR specified in the global config)\.
34+
.IP "\(bu" 4
3135
\fB\-\-ext=c\fR, \fB\-\-ext=rust\fR Add boilerplate for C or Rust (currently magnus \fIhttps://docs\.rs/magnus\fR based) extension code to the generated project\. This behavior is disabled by default\.
3236
.IP "\(bu" 4
3337
\fB\-\-no\-ext\fR: Do not add extension code (overrides \fB\-\-ext\fR specified in the global config)\.

bundler/lib/bundler/man/bundle-gem.1.ronn

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,15 @@ configuration file using the following names:
4141
Do not create a `CODE_OF_CONDUCT.md` (overrides `--coc` specified in the
4242
global config).
4343

44+
* `--changelog`
45+
Add a `CHANGELOG.md` file to the root of the generated project. If
46+
this option is unspecified, an interactive prompt will be displayed and the
47+
answer will be saved in Bundler's global config for future `bundle gem` use.
48+
49+
* `--no-changelog`:
50+
Do not create a `CHANGELOG.md` (overrides `--changelog` specified in the
51+
global config).
52+
4453
* `--ext=c`, `--ext=rust`
4554
Add boilerplate for C or Rust (currently [magnus](https://docs.rs/magnus) based) extension code to the generated project. This behavior
4655
is disabled by default.

0 commit comments

Comments
 (0)