1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify section about getting the Ruby tarball

Browse Source
This commit is contained in:
Benoit Daloze 2023-02-07 20:22:14 +01:00 committed by GitHub
parent 91b18dc88c
commit 826067b0f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/distribution.md
View File

@ -2,9 +2,21 @@
This document outlines the expected way to distribute Ruby, with a specific focus on building Ruby packages. 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: At Ruby source tree cloned using git:
```sh-session ```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). 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 ## 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. 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.