summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAgeFilesLines
* Fix BUNDLE_PATH_RELATIVE_TO_CWD env variable namefix_env_variable_nameDavid Rodríguez2018-10-201-1/+1
|
* Make the equivalent change to `bundle update`David Rodríguez2018-09-181-2/+2
|
* Document the supported optionDavid Rodríguez2018-09-181-2/+2
|
* Update the Gemfile documentation to reflect the addition of TruffleRuby in ↵Benoit Daloze2018-09-091-6/+8
| | | | Bundler
* [Settings] Append the ruby scope on Bundler 2 with a global path settingSamuel Giddins2018-07-291-0/+3
|
* Auto merge of #6513 - agrim123:agr-bundler-remove, r=indirectThe Bundler Bot2018-07-021-0/+23
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add `bundle remove` Features of the command implemented: - Multiple gems support ```bash $ bundle remove rack rails ``` - Remove any empty block that might occur after removing the gem or otherwise present Things yet to implement: - Add `rm` alias. _Optional_ - [x] Add `--install` flag to remove gems from `.bundle`. - [x] Handling multiple gems on the same line. - [x] Handle gem spec - [x] Handle eval_gemfile cases ([one](https://github.com/bundler/bundler/pull/6513#discussion_r195632603) case left) Closes #6506
| * Update documentationAgrim Mittal2018-07-011-6/+4
| |
| * Remove necessary comments and update documentationAgrim Mittal2018-06-281-3/+3
| |
| * Remove necessary comments and update docsAgrim Mittal2018-06-281-1/+1
| |
| * Add gemfile error when gem is not presentAgrim Mittal2018-06-281-1/+1
| |
| * Update documentationAgrim Mittal2018-06-281-2/+11
| |
| * Add man page for removeAgrim Mittal2018-06-281-0/+16
| |
* | Auto merge of #6613 - kemitchell:mention-show-sorts-in-doc, r=colby-swandaleThe Bundler Bot2018-07-011-2/+3
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document that `bundle show [--paths]` sorts results ### What was the end-user problem that led to this PR? The problem was that I could not tell from the manpage or documentation website whether `bundle show` and `bundle show --paths` would list gems and gem paths in the same order. I am using `bundle show` and `bundle show --paths` to inventory gems that projects depend upon. ### What was your diagnosis of the problem? My diagnosis was that the implementation of `bundle show` _does_ sort results by name, but that the manpage for the subcommand doesn't mention this. ### What is your fix for the problem, implemented in this PR? My fix involved slightly editing the existing manpage for `bundle show`. ### Why did you choose this fix out of the possible options? I chose this fix because the `.ronn` file text matched the current text I was seeing via the documentation website.
| * | Document that `bundle show [--paths]` sorts resultsKyle E. Mitchell2018-06-301-2/+3
| |/
* | Auto merge of #6605 - forestgagnon:refine-gemfile-source-warning, r=segiddinsThe Bundler Bot2018-07-011-0/+13
|\ \ | |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | add warning to docs for explicit source gotcha See https://github.com/bundler/bundler/issues/6280 for more context. This PR adds a warning to the Gemfile documentation to more clearly indicate that specifying an explicit source on a per-gem or block basis also makes that scoped source a global source. Also adds a recommendation that users ensure that all gems in the Gemfile are using explicit sources whenever they introduce any explicit source blocks or source directives on individual gems. If the root cause cannot be fixed until v2, I think this gotcha should be documented in all existing bundler versions which have this behavior, which as far as I can tell is all versions supporting explicit sources via blocks/per-gem directives. I believe it merits a warning because the behavior is non-intuitive, and represents a potential security issue if it is not understood and avoided. I don't know how backporting for documentation is performed, so I'm making this PR against master for now. Please let me know if I need to do anything else. ### What was the end-user problem that led to this PR? Unclear behavior when mixing global sources with source blocks, as outlined in https://github.com/bundler/bundler/issues/6280 . No documentation was present that described this behavior. ### What was your diagnosis of the problem? Having docs would have been helpful! ### What is your fix for the problem, implemented in this PR? Add documentation ### Why did you choose this fix out of the possible options? It was suggested that I make a PR to add documentation here: https://github.com/bundler/bundler/issues/6280#issuecomment-400535496 ## To Reproduce ```ruby source 'https://code.stripe.com/' source 'https://rubygems.org' do gem 'fattr' end gem 'mime-types' ``` results in this warning on v1.16.2, telling me that it preferred https://rubygems.org for the `mime-types` gem, which is counterintuitive when looking at the Gemfile. ``` Warning: the gem 'mime-types' was found in multiple sources. Installed from: https://rubygems.org/ Also found in: * https://code.stripe.com/ You should add a source requirement to restrict this gem to your preferred source. For example: gem 'mime-types', :source => 'https://rubygems.org/' Then uninstall the gem 'mime-types' (or delete all bundled gems) and then install again. ``` Here is a Dockerfile that reproduces the issue when built, for source blocks: ```Dockerfile FROM ruby:2.5.1-alpine WORKDIR /test RUN echo $'\n\ source "https://code.stripe.com/" \n\ source "https://rubygems.org" do \n\ gem "fattr" \n\ end \n\ gem "mime-types" \n\ ' >> ./Gemfile RUN bundle install --verbose # the source ambiguity warning doesn't show up on the initial install for some reason RUN rm -rf /usr/local/bundle/**/* RUN bundle install RUN cat Gemfile ``` Here is another Dockerfile that reproduces the issue when built, for a source directive on an individual `gem` function call: ```Dockerfile FROM ruby:2.5.1-alpine WORKDIR /test RUN echo $'\n\ source "https://code.stripe.com/" \n\ gem "fattr", source: "https://rubygems.org" \n\ gem "mime-types" \n\ ' >> ./Gemfile RUN bundle install --verbose # the source ambiguity warning doesn't show up on the initial install for some reason RUN rm -rf /usr/local/bundle/**/* RUN bundle install RUN cat Gemfile ```
| * add warning to docs for explicit source gotchaForest Gagnon2018-06-291-0/+13
| | | | | | | | | | | | | | | | | | This commit adds a warning to the Gemfile documentation to more clearly indicate that specifying an explicit source on a per-gem or block basis also makes that scoped source a global source. Also adds a recommendation that users ensure that all gems in the Gemfile are using explicit sources whenever they introduce any explicit source blocks or source directives on individual gems.
* | Change options to --without-group and --only-groupAgrim Mittal2018-06-171-6/+6
| | | | | | | | Improves understanding of the options without need to look up the docs.
* | Add documentation for bundle list without and only optionsAgrim Mittal2018-06-151-1/+17
|/
* Auto merge of #6531 - peret:outdated-filter-dependencies, r=segiddinsThe Bundler Bot2018-06-151-0/+4
|\ | | | | | | | | | | Add option to filter gem-dependencies from output of 'bundle outdated' Resolves #5366 by adding a new option '--filter-dependencies' to `bundle outdated`. When present, `outdated` will only check the `gemfile_specs` and skip the `dependency_specs`.
| * Rename --filter-dependencies to --only-explicit.Peter Retzlaff2018-06-041-2/+2
| |
| * Add --filter-dependencies option to the `bundle outdated` man-pagePeter Retzlaff2018-05-121-0/+4
| |
* | Auto merge of #6556 - agrim123:agr-versions-gem-add, r=colby-swandaleThe Bundler Bot2018-06-061-1/+7
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [bundle add] Add version prefix flexibility ### What was the end-user problem that led to this PR? By default, on `bundle add` we use "pessimistic" way (~>) of versions. According to this [comment](https://github.com/bundler/bundler/issues/6553#issue-326023952) some users face problems. ### What was your diagnosis of the problem? Adding flags to provide flexibility to change this declaration namely `optimistic` and `strict` ### What is your fix for the problem, implemented in this PR? Adding flags to opt for other declarations. ### Why did you choose this fix out of the possible options? Currently, its an experiment and I have added it to only `bundle add` but still the version locked in lockfile are "pessimistic". Need suggestions on this and on how to proceed. Addresses #6553
| * | Add documentation for optionsAgrim Mittal2018-05-291-1/+7
| | |
* | | Auto merge of #6539 - BanzaiMan:ha-fix-man-page-links, r=segiddinsThe Bundler Bot2018-05-2512-43/+43
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix man page links With a markup [`bundle platform(1)`][bundle-platform(1)] ronn creates this HTML fragment <a href="bundle-platform.html"><code>bundle platform(1)</code></a> At the same time, it generates HTML file `bundle-platform.1.html` based on the man page section, and this results in certain inter-man-page links 404. We resolve this inconsistency by spelling out the href attributes. ----- Thanks so much for the contribution! To make reviewing this PR a bit easier, please fill out answers to the following questions. ### What was the end-user problem that led to this PR? 404's on https://bundler.io. For example, https://bundler.io/v1.16/man/bundle.1.html has the link to `bundle platform(1)`: <img width="1061" alt="bundler__bundle" src="https://user-images.githubusercontent.com/25666/40212893-7fc73196-5a20-11e8-8964-5ca5ed9abfa2.png"> This points to https://bundler.io/v1.16/man/bundle-platform.html, but it is 404. The correct link is https://bundler.io/v1.16/man/bundle-platform.1.html. ### What was your diagnosis of the problem? My diagnosis was... that the document source was wrong. ### What is your fix for the problem, implemented in this PR? My fix... is this PR. ### Why did you choose this fix out of the possible options? I chose this fix because... `ronn -5 man/*.ronn` appears to generate `<a>` tags with the correct `href` attributes. I tried serving the generated files with `bundler-site`, but I could not convince it to do so; `bundler-site`'s Rake tasks assumes the document source *always* comes from the remote `bundler/bundler`, and coming up with a way to test it seemed rather involved.
| * | Fix more linksHiro Asari2018-05-171-1/+1
| | |
| * | Fix more linksHiro Asari2018-05-171-2/+2
| | |
| * | Fix man page linksHiro Asari2018-05-1712-41/+41
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | With markup [`bundle platform(1)`][bundle-platform(1)] ronn creates this HTML fragment <dt><a href="bundle-platform.html"><code>bundle platform(1)</code></a></dt><dd><p>Display platform compatibility information</p></dd> At the same time, it generates HTML file `bundle-platform.1.html` based on the man page section, and this results in certain inter-man-page links 404. We resolve this inconsistency by spelling out the href attributes.
* | Add documentation for --skip-install flagAgrim Mittal2018-05-141-2/+7
|/
* Add documentation for --all flag of bundle updateAgrim Mittal2018-04-191-6/+10
|
* Document the order Bundler loads settingsStephanie Morillo2018-03-281-5/+9
| | | Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.
* Made small copy tweaks, removed redundant phrasingrubymorillo-patch-2Stephanie Morillo2018-03-271-9/+9
|
* Auto merge of #6302 - 315tky:master, r=indirectThe Bundler Bot2018-03-041-0/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document `# frozen_string_literal` in `bundle init` Gemfile Thanks so much for the contribution! To make reviewing this PR a bit easier, please fill out answers to the following questions. ### What was the end-user problem that led to this PR? An enhancement request to bundle-init docu as per - issue 6140 ### What was your diagnosis of the problem? n/a ### What is your fix for the problem, implemented in this PR? Updated the man/bundle-init.ronn file to include brief description of frozen string literal, and added a SEE ALSO section with link to Gemfile(5) webpage ### Why did you choose this fix out of the possible options? File edited to try and reflect the previous discussion regarding what was required.
| * removed reference to ruby 3saigo2018-03-041-1/+0
| |
| * minor change to literal string related text and moved under FILES sectionsaigo2018-03-041-6/+8
| |
| * corrected for 80 character width limitsaigo2018-02-221-1/+5
| |
| * issue 6140 updated bundle init docusaigo2018-02-211-0/+6
| |
* | Update documentation for disable_platform_warningsAgrim Mittal2018-03-011-1/+1
| |
* | Add documentation and tests for disable_platform_warningsAgrim Mittal2018-02-261-0/+2
|/
* Auto merge of #6184 - arbonap:pa-check-in-gemfile-docs, r=indirectThe Bundler Bot2018-02-131-2/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update docs to reflect revised guidance to check in locks for gems Thanks so much for the contribution! To make reviewing this PR a bit easier, please fill out answers to the following questions. ### What was the end-user problem that led to this PR? The problem was... - Bundler stopped gitignoring gem locks. The change was merged in but we need to reflect that change in documentation. ### What was your diagnosis of the problem? My diagnosis was... - To add in documentation explaining why Bunder now does _not_ gitignore gem locks. ### What is your fix for the problem, implemented in this PR? My fix... - Update the `gemfile.lock` section of `bundle install` man pages as well as the `gemfile` man page. ### Why did you choose this fix out of the possible options? I chose this fix because... - This addresses open issue https://github.com/bundler/bundler/issues/5879
| * Tweak language, remove lock info from Gemfile doc.Andre Arko2018-02-122-17/+8
| | | | | | | | | | | | After reviewing, I think the question and answer is a bad fit for the `gemfile` man page. It does seem like a good fit for the FAQ page on the Bundler documentation site, though, and I'll add it over there.
| * Update docs to reflect revised guidance to check in locks for gemsPatricia Arbona2017-11-222-2/+20
| |
* | Fix typosNick Holden2018-02-011-2/+2
| |
* | Expand on problems checked by bundle-doctorNick Holden2018-01-311-6/+13
| |
* | Add info about `--gemfile` option to `bundle doctor` man pageNick Holden2018-01-241-0/+8
| |
* | Add man page for `bundle doctor`Nick Holden2018-01-231-0/+18
| | | | | | | | Addresses https://github.com/bundler/bundler/issues/6243
* | Auto merge of #6235 - Debian:samueloph_typo, r=colby-swandaleThe Bundler Bot2018-01-161-1/+1
|\ \ | | | | | | | | | | | | | | | [man] fix typo on bundle-binstubs Typo found while i was packaging 1.16.1 for Debian
| * | [man] fix typo on bundle-binstubsSamuel Henrique2017-12-281-1/+1
| | |
* | | Auto merge of #6244 - bundler:seg-audit-man-links, r=colby-swandaleThe Bundler Bot2018-01-0816-55/+55
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [Man] Audit links to other manpages ### What was the end-user problem that led to this PR? The problem was links to many of our man pages were broken. Closes https://github.com/bundler/bundler-site/issues/355. ### What was your diagnosis of the problem? My diagnosis was we were omitting the section in the link ID. ### What is your fix for the problem, implemented in this PR? My fix manually updates the link IDs to be correct.
| * | | [Man] Audit links to other manpagesseg-audit-man-linksSamuel Giddins2018-01-0416-55/+55
| |/ /
* | | Auto merge of #6177 - bundler:colby/bundle-show-paths, r=indirectThe Bundler Bot2018-01-081-0/+2
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | add `--paths` option to `bundle list` command. See #6172 This option mimics the `--paths` options in `bundle show` which is being removed in Bundler 2. Example Usage: ``` $ bundle list --paths /Users/c/Desktop/Projects/testapp/.bundle/ruby/2.4.0/gems/actioncable-5.1.4 /Users/c/Desktop/Projects/testapp/.bundle/ruby/2.4.0/gems/actionmailer-5.1.4 /Users/c/Desktop/Projects/testapp/.bundle/ruby/2.4.0/gems/actionpack-5.1.4 /Users/c/Desktop/Projects/testapp/.bundle/ruby/2.4.0/gems/actionview-5.1.4 ```