Skip to content
This repository has been archived by the owner. It is now read-only.

Add man page for `bundle doctor` #6271

Merged
merged 4 commits into from Feb 1, 2018

Conversation

@nholden
Copy link
Contributor

@nholden nholden commented Jan 24, 2018

What was the end-user problem that led to this PR?

The bundle doctor command was missing a man page (see #6243).

What was your diagnosis of the problem?

Running bundle help doctor from the command line showed the description from cli.rb, but it wasn't displayed in the same format as commands with man pages. Documentation for bundle doctor was also missing from http://bundler.io/docs.

What is your fix for the problem, implemented in this PR?

I added a man page for bundle doctor.

Why did you choose this fix out of the possible options?

I chose this fix because the "Writing docs for man pages" documentation says...

Our goal is to have a man page for every command.

Addresses #6243
@ghost
Copy link

@ghost ghost commented Jan 24, 2018

Thanks for opening a pull request and helping make Bundler better! Someone from the Bundler team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use Travis CI to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of Travis CI in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #bundler channel on Slack.

For more information about contributing to the Bundler project feel free to review our CONTRIBUTING guide

## OPTIONS

* `--quiet`:
Only output warnings and errors.

This comment has been minimized.

@nholden

nholden Jan 24, 2018
Author Contributor

I wasn't sure which options I should add here. Running bundle help doctor currently shows --gemfile, --quiet, --no-quiet, --no-color, --retry=NUM, --verbose, and --no-verbose.

It doesn't look like most of the other man pages include anything about the options that are shared between commands, so I left most of them out. I included quiet only because there's a specific reference to it in Doctor, but even then it doesn't appear to be a different implementation from other commands.

Let me know how you'd like to handle this!

This comment has been minimized.

@colby-swandale

colby-swandale Jan 24, 2018
Member

I would document --quiet and the --gemfile, you can ignore everything else.

This comment has been minimized.

@nholden

nholden Jan 25, 2018
Author Contributor

Sounds good! I borrowed the description of --gemfile from the bundle install man page.

Copy link
Member

@colby-swandale colby-swandale left a comment

Great start! let us know if you have any questions.

@@ -0,0 +1,18 @@
bundle-doctor(1) -- Checks for missing OS dependencies

This comment has been minimized.

@colby-swandale

colby-swandale Jan 24, 2018
Member

I would just say Checks the bundle for common problems because bundler doctor is intended to do more than just checking for OS dependencies.

This comment has been minimized.

@nholden

nholden Jan 25, 2018
Author Contributor

Gotcha. I'll read up on bundle doctor and flesh the description out a bit.

## OPTIONS

* `--quiet`:
Only output warnings and errors.

This comment has been minimized.

@colby-swandale

colby-swandale Jan 24, 2018
Member

I would document --quiet and the --gemfile, you can ignore everything else.


## DESCRIPTION

Scan the OS dependencies of each of the gems requested in your

This comment has been minimized.

@colby-swandale

colby-swandale Jan 24, 2018
Member

Same here as my last comment. bundler doctor is intended to be a general purpose "check for anything wrong about my Gemfile and gem env", not just checking OS dependencies. See #6129 as an example.

I would start off with just a general overview and then start going into the specifics about what bundle doctor is doing.

This comment has been minimized.

@nholden

nholden Feb 1, 2018
Author Contributor

Thanks again for your feedback! I explored the source code a bit and unpacked more of what bundler doctor checks for. Would you mind taking another look? Is there anything I'm missing, or do you think it makes sense to go further in depth on any of those items?

@colby-swandale
Copy link
Member

@colby-swandale colby-swandale commented Jan 27, 2018

#6275 should fix this failing spec

Copy link
Member

@olleolleolle olleolleolle left a comment

Thanks for coming to build this man page!


Checks your Gemfile and gem environment for common problems. If issues
are detected, Bundler prints them and exists status 1. Otherwise,
Bundler prints a success message and exists status 0.

This comment has been minimized.

@olleolleolle

olleolleolle Feb 1, 2018
Member

(Awesome that you decided to build a man page for this!)

Typo: exists => exits.

Suggestion: exists status 1 => exits with status 1. Same, but for the status 0 part of this paragraph.

This comment has been minimized.

@nholden

nholden Feb 1, 2018
Author Contributor

Thanks for the good catch! I fixed the typos in c5f0852.

@portexedge
Copy link

@portexedge portexedge commented Feb 1, 2018

@nholden
Copy link
Contributor Author

@nholden nholden commented Feb 1, 2018

Hey, @portexedge! If you're trying to unsubscribe from emails about this repository, head over to https://github.com/bundler/bundler, log in, click the "unwatch" button toward the top right of the page, and then select "not watching."

Since you're now subscribed to this thread, you may also need to go to #6271 and click "unsubscribe" under "notifications" in the right column.

@colby-swandale
Copy link
Member

@colby-swandale colby-swandale commented Feb 1, 2018

@bundlerbot
Copy link
Collaborator

@bundlerbot bundlerbot commented Feb 1, 2018

📌 Commit c5f0852 has been approved by colby-swandale

@bundlerbot
Copy link
Collaborator

@bundlerbot bundlerbot commented Feb 1, 2018

Testing commit c5f0852 with merge b26714b...

bundlerbot added a commit that referenced this pull request Feb 1, 2018
Add man page for `bundle doctor`

### What was the end-user problem that led to this PR?

The `bundle doctor` command was missing a man page (see #6243).

### What was your diagnosis of the problem?

Running `bundle help doctor` from the command line showed [the description from `cli.rb`](https://github.com/bundler/bundler/blob/723608f45866cee0f1b315551a8dde6a99efebc6/lib/bundler/cli.rb#L611-L620), but it wasn't displayed in the same format as commands with man pages. Documentation for `bundle doctor` was also missing from http://bundler.io/docs.

### What is your fix for the problem, implemented in this PR?

I added a man page for `bundle doctor`.

### Why did you choose this fix out of the possible options?

I chose this fix because the ["Writing docs for man pages" documentation](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md#what-goes-in-man-pages) says...

> Our goal is to have a man page for every command.
@bundlerbot
Copy link
Collaborator

@bundlerbot bundlerbot commented Feb 1, 2018

☀️ Test successful - status-travis
Approved by: colby-swandale
Pushing b26714b to master...

@bundlerbot bundlerbot merged commit c5f0852 into rubygems:master Feb 1, 2018
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
homu Test successful
Details
@nholden nholden deleted the nholden:bundle-doctor-man-page branch Feb 1, 2018
@colby-swandale colby-swandale added this to the 1.16.2 milestone Feb 1, 2018
colby-swandale added a commit that referenced this pull request Apr 11, 2018
Add man page for `bundle doctor`

### What was the end-user problem that led to this PR?

The `bundle doctor` command was missing a man page (see #6243).

### What was your diagnosis of the problem?

Running `bundle help doctor` from the command line showed [the description from `cli.rb`](https://github.com/bundler/bundler/blob/723608f45866cee0f1b315551a8dde6a99efebc6/lib/bundler/cli.rb#L611-L620), but it wasn't displayed in the same format as commands with man pages. Documentation for `bundle doctor` was also missing from http://bundler.io/docs.

### What is your fix for the problem, implemented in this PR?

I added a man page for `bundle doctor`.

### Why did you choose this fix out of the possible options?

I chose this fix because the ["Writing docs for man pages" documentation](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md#what-goes-in-man-pages) says...

> Our goal is to have a man page for every command.

(cherry picked from commit b26714b)
colby-swandale added a commit that referenced this pull request Apr 20, 2018
Add man page for `bundle doctor`

### What was the end-user problem that led to this PR?

The `bundle doctor` command was missing a man page (see #6243).

### What was your diagnosis of the problem?

Running `bundle help doctor` from the command line showed [the description from `cli.rb`](https://github.com/bundler/bundler/blob/723608f45866cee0f1b315551a8dde6a99efebc6/lib/bundler/cli.rb#L611-L620), but it wasn't displayed in the same format as commands with man pages. Documentation for `bundle doctor` was also missing from http://bundler.io/docs.

### What is your fix for the problem, implemented in this PR?

I added a man page for `bundle doctor`.

### Why did you choose this fix out of the possible options?

I chose this fix because the ["Writing docs for man pages" documentation](https://github.com/bundler/bundler/blob/master/doc/documentation/WRITING.md#what-goes-in-man-pages) says...

> Our goal is to have a man page for every command.

(cherry picked from commit b26714b)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.