From 2516759c12bc87f25162bd204fbd26be74b4dedb Mon Sep 17 00:00:00 2001 From: Himanshu Jain <124277196+hjain-perforce@users.noreply.github.com> Date: Mon, 22 May 2023 22:04:47 +0530 Subject: [PATCH 1/3] Update build.md Removing extra lines --- build.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/build.md b/build.md index eefe641..25b6392 100644 --- a/build.md +++ b/build.md @@ -4,33 +4,33 @@ 1. Download the Perforce C++ API from the Perforce FTP site at . \ The API archive is located in release and platform-specific subdirectories and is named - *"p4api-glibc2.3-openssl1.1.1.tgz".

* + *"p4api-glibc2.3-openssl1.1.1.tgz".
* **Note: 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\ -           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.

** - Unzip the archive into an empty directory.

+           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.
** + Unzip the archive into an empty directory.
-2. Extract the P4Ruby API archive into a new, empty directory.

+2. Extract the P4Ruby API archive into a new, empty directory.
-3. Execute the build commands:

+3. Execute the build commands:
*bundle install \ bundle exec rake compile -- --with-p4api_dir= \ -            --with-ssl-dir=

* +            --with-ssl-dir=
* OR pass through environment variables\ - *bundle exec rake compile p4api_dir=<*absolute path to Perforce C++ API*>

* + *bundle exec rake compile p4api_dir=<*absolute path to Perforce C++ API*>
* **Note: If the --p4api_dir flag is not provided, P4Ruby will attempt\ - to download and extract correct version of Perforce C++ API

** + to download and extract correct version of Perforce C++ API
** -4. Test your distribution.

+4. Test your distribution.
- *bundle exec rake test

* + *bundle exec rake test
* - Tests require the perforce server binary (p4d) present in the path.

+ Tests require the perforce server binary (p4d) present in the path.
-5. Install P4Ruby into your local gem cache:

+5. Install P4Ruby into your local gem cache:
*bundle exec rake install* @@ -41,4 +41,4 @@ C++ API has been compiled with this support. If the P4Ruby build detects that OpenSSL is available, it will be included by default. If you want to use libraries deployed to nonstandard -paths, use the --ssl_dir=<*path to Openssl include and lib folders*> \ No newline at end of file +paths, use the --ssl_dir=<*path to Openssl include and lib folders*> From 0432fa3b2eb3d50ad9ebdb9652328268948d1043 Mon Sep 17 00:00:00 2001 From: Himanshu Jain <124277196+hjain-perforce@users.noreply.github.com> Date: Mon, 22 May 2023 22:16:31 +0530 Subject: [PATCH 2/3] Update build.md Removing unnecessary line breaks --- build.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/build.md b/build.md index 25b6392..667c519 100644 --- a/build.md +++ b/build.md @@ -2,35 +2,36 @@ 1. Download the Perforce C++ API from the Perforce FTP site at - . \ + . \ The API archive is located in release and platform-specific subdirectories and is named - *"p4api-glibc2.3-openssl1.1.1.tgz".
* + *"p4api-glibc2.3-openssl1.1.1.tgz".* **Note: 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\ -           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.
** - Unzip the archive into an empty directory.
+           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.** + + Unzip the archive into an empty directory. -2. Extract the P4Ruby API archive into a new, empty directory.
+2. Extract the P4Ruby API archive into a new, empty directory. -3. Execute the build commands:
+3. Execute the build commands: *bundle install \ bundle exec rake compile -- --with-p4api_dir= \ -            --with-ssl-dir=
* +            --with-ssl-dir=* OR pass through environment variables\ - *bundle exec rake compile p4api_dir=<*absolute path to Perforce C++ API*>
* + *bundle exec rake compile p4api_dir=* - **Note: If the --p4api_dir flag is not provided, P4Ruby will attempt\ - to download and extract correct version of Perforce C++ API
** + **Note: If the --p4api_dir flag is not provided, P4Ruby will attempt + to download and extract correct version of Perforce C++ API** -4. Test your distribution.
+4. Test your distribution. - *bundle exec rake test
* + *bundle exec rake test* - Tests require the perforce server binary (p4d) present in the path.
+ Tests require the perforce server binary (p4d) present in the path. -5. Install P4Ruby into your local gem cache:
+5. Install P4Ruby into your local gem cache: *bundle exec rake install* From b220284802a2d5162dff8c08524510987f00db26 Mon Sep 17 00:00:00 2001 From: Himanshu Jain <124277196+hjain-perforce@users.noreply.github.com> Date: Wed, 24 May 2023 16:03:48 +0530 Subject: [PATCH 3/3] Changing installation instruction "bundle exec rake install" not working. Instead of running rake install, first creating gem and then installing the same gem. --- build.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/build.md b/build.md index 667c519..f4f8c02 100644 --- a/build.md +++ b/build.md @@ -1,6 +1,10 @@ # Building P4Ruby from Source + Note: Make sure you have following packages installed on your system: + a. build-essential + b. libssl-dev + 1. Download the Perforce C++ API from the Perforce FTP site at . \ The API archive is located in release and platform-specific subdirectories and is named @@ -30,10 +34,11 @@ *bundle exec rake test* Tests require the perforce server binary (p4d) present in the path. - + 5. Install P4Ruby into your local gem cache: - *bundle exec rake install* + *bundle exec rake gem*\ + *gem install pkg/p4ruby\*.gem -- --with-p4api_dir=* ## SSL support