Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename all occurences of OS X to macOS #117

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The solution that Traveling Ruby advocates, is to distribute your app as a singl
This makes the release process much simpler. Instead of having to create almost 10 packages using a fleet of VMs, you just create 3 packages quickly and easily from your developer laptop. These 3 packages cover all the major platforms that your end users are on:

* Linux x86\_64.
* macOS.
* macOS - *This might also be referred to as OS X at points in this repo*
* Windows. But see [the Windows-specific caveats](#caveats).

However, distributing a precompiled Ruby interpreter that works for all end users, is more easily said than done. [Read this section](#why_precompiled_binary_difficult) to learn why it's difficult.
Expand Down Expand Up @@ -72,7 +72,7 @@ There are also some real-world examples of how people used Traveling Ruby to pac

Native extensions:

* Traveling Ruby only supports native extensions when creating Linux and OS X packages. Native extensions are currently not supported when creating Windows packages.
* Traveling Ruby only supports native extensions when creating Linux and macOS packages. Native extensions are currently not supported when creating Windows packages.
* Traveling Ruby only supports a number of popular native extension gems, and only in some specific versions. You cannot use just any native extension gem.
* Native extensions are covered in [tutorial 3](TUTORIAL-3.md).

Expand All @@ -90,7 +90,7 @@ The Traveling Ruby project supplies binaries that application developers can use

For the Linux build system, see [linux/README.md](linux/README.md).

For the macOS build system, see [osx/README.md](osx/README.md).
For the macOS build system, see [macOS/README.md](macOS/README.md).

## Future work

Expand Down
6 changes: 3 additions & 3 deletions TUTORIAL-1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tutorial 1: hello world

This tutorial teaches you, in 5 minutes, how to use Traveling Ruby to create self-contained packages of a hello world app. This app has no gem dependencies; dependency management is covered in [tutorial 2](TUTORIAL-2.md). We will be creating three packages, namely for Linux x86, Linux x86_64 and OS X.
This tutorial teaches you, in 5 minutes, how to use Traveling Ruby to create self-contained packages of a hello world app. This app has no gem dependencies; dependency management is covered in [tutorial 2](TUTORIAL-2.md). We will be creating three packages, namely for Linux x86, Linux x86_64 and macOS.

This tutorial **does not cover Windows**. This tutorial [will not work on Windows](README.md#caveats); nor will this tutorial generate packages for Windows. The creation of packages for Windows is covered in [tutorial 4](TUTORIAL-4.md).

Expand Down Expand Up @@ -85,7 +85,7 @@ Your directory structure will now look like this:

### Quick sanity testing

Let's do a basic sanity test by running your app with a bundled Ruby interpreter. Suppose that you are developing on OS X. Run this:
Let's do a basic sanity test by running your app with a bundled Ruby interpreter. Suppose that you are developing on macOS. Run this:

```Bash
cd hello-1.0.0-osx
Expand Down Expand Up @@ -174,7 +174,7 @@ namespace :package do
end
end

desc "Package your app for OS X"
desc "Package your app for osx"
task :osx => "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz" do
create_package("osx")
end
Expand Down
2 changes: 1 addition & 1 deletion TUTORIAL-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ namespace :package do
end
end

desc "Package your app for OS X"
desc "Package your app for osx"
task :osx => [:bundle_install, "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz"] do
create_package("osx")
end
Expand Down
4 changes: 2 additions & 2 deletions TUTORIAL-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ $ rm -rf hello-1.0.0-linux-x86_64
$ rm -rf hello-1.0.0-osx
```

Now you can test whether it works. Suppose that you're developing on OS X. Extract the OS X package and test it:
Now you can test whether it works. Suppose that you're developing on macOS. Extract the macOS package and test it:

```
$ tar xzf hello-1.0.0-osx.tar.gz
Expand Down Expand Up @@ -161,7 +161,7 @@ namespace :package do
end
end

desc "Package your app for OS X"
desc "Package your app for osx"
task :osx => [:bundle_install,
"packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz",
"packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx-sqlite3-#{SQLITE3_VERSION}.tar.gz"
Expand Down
6 changes: 3 additions & 3 deletions TUTORIAL-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can find the end result of this tutorial at https://github.com/phusion/trave

## Creating a batch file

Suppose that we want to create a Windows package for our hello world app from [tutorial 2](TUTORIAL-2.md). The first thing we need to create is a Windows wrapper script. We already have a Unix wrapper script in `packaging/wrapper.sh`, which works on Linux and OS X, but Windows doesn't support Unix shell scripts. For Windows we'll need to create a wrapper script in the DOS batch format.
Suppose that we want to create a Windows package for our hello world app from [tutorial 2](TUTORIAL-2.md). The first thing we need to create is a Windows wrapper script. We already have a Unix wrapper script in `packaging/wrapper.sh`, which works on Linux and macOS, but Windows doesn't support Unix shell scripts. For Windows we'll need to create a wrapper script in the DOS batch format.

Create `packaging/wrapper.bat`:

Expand All @@ -25,7 +25,7 @@ set BUNDLE_IGNORE_CONFIG=

## Modifying the Rakefile

The next step is to add a Rake task for creating the Windows package. The Rakefile currently generates tar.gz packages for Linux and OS X, but tar.gz is not a common format on Windows. For Windows, we'll want to create a .zip package instead.
The next step is to add a Rake task for creating the Windows package. The Rakefile currently generates tar.gz packages for Linux and macOS, but tar.gz is not a common format on Windows. For Windows, we'll want to create a .zip package instead.

Add a `package:win32` task to your Rakefile:

Expand Down Expand Up @@ -89,7 +89,7 @@ task :package => ['package:linux:x86', 'package:linux:x86_64', 'package:osx', 'p

## Creating and testing the package

Congratulations. The `rake package` command will now generate packages for Windows, Linux and OS X. But let's test the Windows package. Run the following command to generate a Windows package:
Congratulations. The `rake package` command will now generate packages for Windows, Linux and macOS. But let's test the Windows package. Run the following command to generate a Windows package:

```Bash
rake package:win32
Expand Down
2 changes: 1 addition & 1 deletion osx/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Traveling Ruby OS X build system
# Traveling Ruby macOS build system

The build system requires the Developer Commandline Tools to be installed, as well as a number of other things. See the "System requirements" section.

Expand Down
Empty file modified osx/build-ruby
100755 → 100644
Empty file.
Empty file modified osx/internal/bin/c++
100755 → 100644
Empty file.
Empty file modified osx/internal/bin/cc
100755 → 100644
Empty file.
1 change: 0 additions & 1 deletion osx/internal/bin/clang

This file was deleted.

1 change: 1 addition & 0 deletions osx/internal/bin/clang
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
cc
1 change: 0 additions & 1 deletion osx/internal/bin/clang++

This file was deleted.

1 change: 1 addition & 0 deletions osx/internal/bin/clang++
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
c++
Empty file modified osx/internal/check_requirements
100755 → 100644
Empty file.
Empty file modified osx/internal/sanity_check
100755 → 100644
Empty file.
Empty file modified osx/package
100755 → 100644
Empty file.
Empty file modified osx/setup-runtime
100755 → 100644
Empty file.
Empty file modified osx/test-gems
100755 → 100644
Empty file.