diff options
| author | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-07-10 17:26:55 +0200 |
|---|---|---|
| committer | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-08-10 12:05:10 +0200 |
| commit | 23de1d0177646ab73bd9ed193e29335c3a64dd5c (patch) | |
| tree | cc4303301dc728d71e48183f42dac9be1cc67b41 /man/bundle-pristine.1 | |
| parent | 27b95a172c9200e77034bb113fe1633d2150552f (diff) | |
| download | bundler-23de1d0177646ab73bd9ed193e29335c3a64dd5c.tar.gz | |
Commit man pages to source control
This has the benefit that:
* Allows the installation of bundler as a default gem from rubygems to
include man pages.
* Removes the need to build man pages during our tests.
* Makes working with the manifest easier, because we only have source
controlled files, and not a mix of source control and generated files.
To make sure they never fall out of sync, we replace the previous
`man:build` CI task with a `man:check` task that makes sure the
generated man pages are up to date.
Diffstat (limited to 'man/bundle-pristine.1')
| -rw-r--r-- | man/bundle-pristine.1 | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/man/bundle-pristine.1 b/man/bundle-pristine.1 new file mode 100644 index 0000000000..9660a49835 --- /dev/null +++ b/man/bundle-pristine.1 @@ -0,0 +1,34 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-PRISTINE" "1" "August 2019" "" "" +. +.SH "NAME" +\fBbundle\-pristine\fR \- Restores installed gems to their pristine condition +. +.SH "SYNOPSIS" +\fBbundle pristine\fR +. +.SH "DESCRIPTION" +\fBpristine\fR restores the installed gems in the bundle to their pristine condition using the local gem cache from RubyGems\. For git gems, a forced checkout will be performed\. +. +.P +For further explanation, \fBbundle pristine\fR ignores unpacked files on disk\. In other words, this command utilizes the local \fB\.gem\fR cache or the gem\'s git repository as if one were installing from scratch\. +. +.P +Note: the Bundler gem cannot be restored to its original state with \fBpristine\fR\. One also cannot use \fBbundle pristine\fR on gems with a \'path\' option in the Gemfile, because bundler has no original copy it can restore from\. +. +.P +When is it practical to use \fBbundle pristine\fR? +. +.P +It comes in handy when a developer is debugging a gem\. \fBbundle pristine\fR is a great way to get rid of experimental changes to a gem that one may not want\. +. +.P +Why use \fBbundle pristine\fR over \fBgem pristine \-\-all\fR? +. +.P +Both commands are very similar\. For context: \fBbundle pristine\fR, without arguments, cleans all gems from the lockfile\. Meanwhile, \fBgem pristine \-\-all\fR cleans all installed gems for that Ruby version\. +. +.P +If a developer forgets which gems in their project they might have been debugging, the Rubygems \fBgem pristine [GEMNAME]\fR command may be inconvenient\. One can avoid waiting for \fBgem pristine \-\-all\fR, and instead run \fBbundle pristine\fR\. |