-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Restore remembered options in manpages #7242
Conversation
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 |
8a633c1
to
509f4a7
Compare
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. |
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. |
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. |
@deivid-rodriguez okay, added some notes on future changes. |
@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:
|
Ping @uasi. |
c16bb52
to
e4bf321
Compare
I fixed this PR with my own feedback, because I really want to include this in the next release! |
e4bf321
to
819d316
Compare
And instead educate users on the preferred, non deprecated, way.
819d316
to
9cd6238
Compare
Going in! Thanks @uasi! @bundlerbot r+ |
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]>
Build succeeded |
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.