diff options
| author | Benoit Daloze <eregontp@gmail.com> | 2023-02-07 20:22:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-07 20:22:14 +0100 |
| commit | 826067b0f970fe7d5514c908be5a30c308a836b5 (patch) | |
| tree | 868e1609fb12e0a8810aad5924dbe01570020ff8 /doc | |
| parent | 91b18dc88cd1d7737ceff13d3b2d250f63230177 (diff) | |
| download | ruby-826067b0f970fe7d5514c908be5a30c308a836b5.tar.gz | |
Clarify section about getting the Ruby tarball
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/distribution.md | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/doc/distribution.md b/doc/distribution.md index fd918576e7..d91cbe7be8 100644 --- a/doc/distribution.md +++ b/doc/distribution.md @@ -2,9 +2,21 @@ This document outlines the expected way to distribute Ruby, with a specific focus on building Ruby packages. -## Building a Ruby Tarball +## Getting the Ruby Tarball -The standard way to build a package for distribution is to build a tarball. This tarball includes all the related files need to build and install Ruby correctly. This includes the Ruby source code, the Ruby standard library, and the Ruby documentation. +### Official Releases + +The tarball for official releases is created by the release manager. The release manager uploads the tarball to the [Ruby website](https://www.ruby-lang.org/en/downloads/). + +Downstream distributors should use the official release tarballs as part of their build process. This ensures that the tarball is created in a consistent way, and that the tarball is crytographically verified. + +### Using the nightly tarball for testing + +See the Snapshots section of the [Ruby website](https://www.ruby-lang.org/en/downloads/). + +### Building a manual snapshot tarball for testing + +This can be useful if the nightly tarball does not have all changes yet. At Ruby source tree cloned using git: ```sh-session @@ -16,12 +28,6 @@ $ make dist This will create several tarball in the `tmp` directory. The tarball will be named e.g. `ruby-<version>.tar.gz` (several different compression formats will be generated). -### Official Releases - -The tarball for official releases is created by the release manager. The release manager will run the above commands to create the tarball. The release manager will then upload the tarball to the [Ruby website](https://www.ruby-lang.org/en/downloads/). - -Downstream distributors should use the official release tarballs as part of their build process. This ensures that the tarball is created in a consistent way, and that the tarball is crytographically verified. - ## Updating the Ruby Standard Library The Ruby standard library is a collection of Ruby files that are included with Ruby. These files are used to provide the basic functionality of Ruby. The standard library is located in the `lib` directory and is distributed as part of the Ruby tarball. |