|
1 | 1 | # Building P4Ruby from Source |
2 | 2 |
|
3 | 3 |
|
4 | | - Note: Make sure you have following packages installed on your system: |
5 | | - a. build-essential |
6 | | - b. libssl-dev |
| 4 | +1. Make sure you have following packages installed on your system:\ |
| 5 | + a. build-essential\ |
| 6 | + b. libssl-dev |
7 | 7 |
|
8 | | -1. Download the Perforce C++ API from the Perforce FTP site at |
9 | | - <ftp://ftp.perforce.com/perforce> . \ |
| 8 | +2. Download the Perforce C++ API from the Perforce FTP site at |
| 9 | + <https://ftp.perforce.com/perforce>. \ |
10 | 10 | The API archive is located in release and platform-specific subdirectories and is named |
11 | 11 | *"p4api-glibc2.3-openssl1.1.1.tgz".* |
12 | 12 |
|
13 | | - **Note: 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\ |
14 | | - 64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.** |
| 13 | + **Note:** 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\ |
| 14 | + 64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby. |
15 | 15 |
|
16 | 16 | Unzip the archive into an empty directory. |
17 | 17 |
|
18 | | -2. Extract the P4Ruby API archive into a new, empty directory. |
| 18 | +3. Extract the P4Ruby API archive into a new, empty directory. |
19 | 19 |
|
20 | | -3. Execute the build commands: |
| 20 | +4. Execute the build commands: |
21 | 21 |
|
22 | | - *bundle install \ |
23 | | - bundle exec rake compile -- --with-p4api_dir=<absolute path to Perforce C++ API> \ |
24 | | - --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API>* |
25 | | - |
26 | | - OR pass through environment variables\ |
27 | | - *bundle exec rake compile p4api_dir=<absolute path to Perforce C++ API>* |
28 | | - |
29 | | - **Note: If the --p4api_dir flag is not provided, P4Ruby will attempt |
30 | | - to download and extract correct version of Perforce C++ API** |
| 22 | + ``` |
| 23 | + bundle install |
| 24 | + bundle exec rake compile -- --with-p4api_dir=<absolute path to Perforce C++ API> --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API> |
| 25 | + ``` |
| 26 | + OR pass through environment variables |
| 27 | + ``` |
| 28 | + bundle exec rake compile p4api_dir=<absolute path to Perforce C++ API> |
| 29 | + ``` |
| 30 | + **Note:** If the --p4api_dir flag is not provided, P4Ruby will attempt |
| 31 | + to download and extract correct version of Perforce C++ API. |
31 | 32 |
|
32 | | -4. Test your distribution. |
| 33 | +5. Test your distribution. |
33 | 34 |
|
34 | | - *bundle exec rake test* |
| 35 | + ``` |
| 36 | + bundle exec rake test |
| 37 | + ``` |
35 | 38 |
|
36 | 39 | Tests require the perforce server binary (p4d) present in the path. |
37 | 40 | |
38 | | -5. Install P4Ruby into your local gem cache: |
| 41 | +6. Install P4Ruby into your local gem cache: |
39 | 42 |
|
40 | | - *bundle exec rake gem*\ |
41 | | - *gem install pkg/p4ruby\*.gem -- --with-p4api_dir=<absolute path to Perforce C++ API>* |
| 43 | + ``` |
| 44 | + bundle exec rake gem |
| 45 | + gem install pkg/p4ruby*.gem -- --with-p4api_dir=<absolute path to Perforce C++ API> |
| 46 | + ``` |
42 | 47 |
|
43 | 48 | ## SSL support |
44 | 49 |
|
|
0 commit comments