Skip to content
This repository has been archived by the owner on Apr 14, 2021. It is now read-only.

Restore remembered options in manpages #7242

Merged
2 commits merged into from
Aug 15, 2019

Conversation

uasi
Copy link
Contributor

@uasi uasi commented Jul 10, 2019

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

The problem was that the remembered options of bundle install were not documented in manpages.

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

Restore the section on remembered options from e120f40 and add description for some options.

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

They should be fully documented.

Closes #7198.

@welcome
Copy link

welcome bot commented Jul 10, 2019

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

@uasi uasi force-pushed the remembered-options-manpages branch from 8a633c1 to 509f4a7 Compare July 10, 2019 15:20
@deivid-rodriguez
Copy link
Member

What if we documented both things? I mean, document how things work on bundler 2.x, but also start spreading the word about the upcoming changes in bundler 3.x by keeping the current documentation as well. Of course, making it obvious that it's future, not current, behavior.

@uasi
Copy link
Contributor Author

uasi commented Jul 11, 2019

Didn't know that the plan to remove remembered options is still on the table. @deivid-rodriguez Is there a tracking issue for the upcoming changes? I think we can say "see this issue for the future changes on remembered options" in the documentation.

@deivid-rodriguez
Copy link
Member

The future changes are what's documented right now, I think. The changes are already implemented and included in master, but they are not yet enabled by default.

@uasi
Copy link
Contributor Author

uasi commented Jul 12, 2019

@deivid-rodriguez okay, added some notes on future changes.

@deivid-rodriguez
Copy link
Member

@uasi Thanks a lot for your efforts. So, in my opinion, the current documentation is almost fine, because the advice it gives it's correct and a good practice for current and future versions of bundler, so we should stick to that.

Only thing we need to do here in my opinion, is to clarify when are options to commands remembered, so my proposed changes here would be along the following lines:

diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index ffecc12f6..069f3b95f 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -51,10 +51,13 @@ config unset disable_multisource` downgrades this error to a warning.
 
 ## REMEMBERING OPTIONS
 
-Flags passed to `bundle install` or the Bundler runtime,
-such as `--path foo` or `--without production`, are not remembered between commands.
-If these options must be remembered, they must be set using `bundle config`
-(e.g., `bundle config set path foo`).
+Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or
+`--without production`, are remembered between commands and saved to your local
+application's configuration (normally, `./.bundle/config`).
+
+However, this will be changed in bundler 3, so it's better not to rely on this
+behavior. If these options must be remembered, it's better to set them using
+`bundle config` (e.g., `bundle config set path foo`).
 
 The options that can be configured are:
 

@deivid-rodriguez
Copy link
Member

Ping @uasi.

@deivid-rodriguez deivid-rodriguez force-pushed the remembered-options-manpages branch from c16bb52 to e4bf321 Compare August 12, 2019 16:47
@deivid-rodriguez
Copy link
Member

I fixed this PR with my own feedback, because I really want to include this in the next release!

@deivid-rodriguez deivid-rodriguez force-pushed the remembered-options-manpages branch from e4bf321 to 819d316 Compare August 14, 2019 14:04
uasi and others added 2 commits August 14, 2019 18:59
And instead educate users on the preferred, non deprecated, way.
@deivid-rodriguez deivid-rodriguez force-pushed the remembered-options-manpages branch from 819d316 to 9cd6238 Compare August 14, 2019 17:07
@deivid-rodriguez
Copy link
Member

Going in! Thanks @uasi!

@bundlerbot r+

ghost pushed a commit that referenced this pull request Aug 15, 2019
7242: Restore remembered options in manpages r=deivid-rodriguez a=uasi

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

The problem was that the remembered options of `bundle install` were not documented in manpages.

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

Restore the section on remembered options from e120f40 and add description for some options.

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

They should be fully documented.

Closes #7198.

Co-authored-by: Tomoki Aonuma <[email protected]>
Co-authored-by: David Rodríguez <[email protected]>
@ghost
Copy link

ghost commented Aug 15, 2019

Build succeeded

This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bundle-config(1) manpage says bundle install doesn't remember options but it does
2 participants