diff options
| author | David RodrÃguez <[email protected]> | 2024-12-11 15:34:11 +0100 |
|---|---|---|
| committer | git <[email protected]> | 2024-12-11 16:18:12 +0000 |
| commit | b37ab8c1232f1ae3b43050f574fdb771a1dedc5c (patch) | |
| tree | 5e8b9c5e2bf69ba0af0d5836f7478f7679ad99f2 | |
| parent | d91ca85b970719aa2b37b8543bac544efe43ecf3 (diff) | |
[rubygems/rubygems] Add missing man pages for `bundle env` and `bundle licenses` commands
https://github.com/rubygems/rubygems/commit/6e1a515d58
| -rw-r--r-- | lib/bundler/man/bundle-env.1 | 9 | ||||
| -rw-r--r-- | lib/bundler/man/bundle-env.1.ronn | 10 | ||||
| -rw-r--r-- | lib/bundler/man/bundle-licenses.1 | 9 | ||||
| -rw-r--r-- | lib/bundler/man/bundle-licenses.1.ronn | 10 | ||||
| -rw-r--r-- | lib/bundler/man/index.txt | 2 | ||||
| -rw-r--r-- | spec/bundler/other/cli_man_pages_spec.rb | 18 |
6 files changed, 50 insertions, 8 deletions
diff --git a/lib/bundler/man/bundle-env.1 b/lib/bundler/man/bundle-env.1 new file mode 100644 index 0000000000..13befeb8f5 --- /dev/null +++ b/lib/bundler/man/bundle-env.1 @@ -0,0 +1,9 @@ +.\" generated with nRonn/v0.11.1 +.\" https://github.com/n-ronn/nronn/tree/0.11.1 +.TH "BUNDLE\-ENV" "1" "December 2024" "" +.SH "NAME" +\fBbundle\-env\fR \- Print information about the environment Bundler is running under +.SH "SYNOPSIS" +\fBbundle env\fR +.SH "DESCRIPTION" +Prints information about the environment Bundler is running under\. diff --git a/lib/bundler/man/bundle-env.1.ronn b/lib/bundler/man/bundle-env.1.ronn new file mode 100644 index 0000000000..c2df9c29c2 --- /dev/null +++ b/lib/bundler/man/bundle-env.1.ronn @@ -0,0 +1,10 @@ +bundle-env(1) -- Print information about the environment Bundler is running under +================================================================================= + +## SYNOPSIS + +`bundle env` + +## DESCRIPTION + +Prints information about the environment Bundler is running under. diff --git a/lib/bundler/man/bundle-licenses.1 b/lib/bundler/man/bundle-licenses.1 new file mode 100644 index 0000000000..6349597a6a --- /dev/null +++ b/lib/bundler/man/bundle-licenses.1 @@ -0,0 +1,9 @@ +.\" generated with nRonn/v0.11.1 +.\" https://github.com/n-ronn/nronn/tree/0.11.1 +.TH "BUNDLE\-LICENSES" "1" "December 2024" "" +.SH "NAME" +\fBbundle\-licenses\fR \- Print the license of all gems in the bundle +.SH "SYNOPSIS" +\fBbundle licenses\fR +.SH "DESCRIPTION" +Prints the license of all gems in the bundle\. diff --git a/lib/bundler/man/bundle-licenses.1.ronn b/lib/bundler/man/bundle-licenses.1.ronn new file mode 100644 index 0000000000..91caba6c2a --- /dev/null +++ b/lib/bundler/man/bundle-licenses.1.ronn @@ -0,0 +1,10 @@ +bundle-licenses(1) -- Print the license of all gems in the bundle +================================================================= + +## SYNOPSIS + +`bundle licenses` + +## DESCRIPTION + +Prints the license of all gems in the bundle. diff --git a/lib/bundler/man/index.txt b/lib/bundler/man/index.txt index 518970aa24..3ea3495f1b 100644 --- a/lib/bundler/man/index.txt +++ b/lib/bundler/man/index.txt @@ -8,6 +8,7 @@ bundle-clean(1) bundle-clean.1 bundle-config(1) bundle-config.1 bundle-console(1) bundle-console.1 bundle-doctor(1) bundle-doctor.1 +bundle-env(1) bundle-env.1 bundle-exec(1) bundle-exec.1 bundle-fund(1) bundle-fund.1 bundle-gem(1) bundle-gem.1 @@ -17,6 +18,7 @@ bundle-init(1) bundle-init.1 bundle-inject(1) bundle-inject.1 bundle-install(1) bundle-install.1 bundle-issue(1) bundle-issue.1 +bundle-licenses(1) bundle-licenses.1 bundle-list(1) bundle-list.1 bundle-lock(1) bundle-lock.1 bundle-open(1) bundle-open.1 diff --git a/spec/bundler/other/cli_man_pages_spec.rb b/spec/bundler/other/cli_man_pages_spec.rb index 037be35360..f99d91b3d5 100644 --- a/spec/bundler/other/cli_man_pages_spec.rb +++ b/spec/bundler/other/cli_man_pages_spec.rb @@ -2,14 +2,16 @@ RSpec.describe "bundle commands" do it "expects all commands to have a man page" do - command_names = - Dir["#{source_root}/lib/bundler/cli/*.rb"]. - grep_v(/common.rb/). - map {|file_path| File.basename(file_path, ".rb") } - - command_names.each do |command_name| - man_page = source_root.join("lib/bundler/man/bundle-#{command_name}.1.ronn") - expect(man_page).to exist + Bundler::CLI.all_commands.each_key do |command_name| + next if command_name == "cli_help" + + expect(man_page(command_name)).to exist end end + + private + + def man_page(command_name) + source_root.join("lib/bundler/man/bundle-#{command_name}.1.ronn") + end end |