From c85d00e2185bf56578968a7862c41a3e3119353e Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Jun 2023 12:44:29 +0800 Subject: [PATCH 1/4] Update README.rst Refine README in cpp about building. --- cpp/README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/cpp/README.rst b/cpp/README.rst index 954d395bb..dbf37e763 100644 --- a/cpp/README.rst +++ b/cpp/README.rst @@ -26,7 +26,7 @@ Building requires: sufficient. For MacOS, at least clang 5 is required * CMake 3.5 or higher * On Linux and macOS, ``make`` build utilities -* curl-devel (Linux) or curl (macOS), for s3 filesystem support +* curl-devel with SSL (Linux) or curl (macOS), for s3 filesystem support Dependencies for optional features: @@ -57,7 +57,7 @@ Release build: $ mkdir build-release $ cd build-release $ cmake .. - $ make -j8 # if you have 8 CPU cores, otherwise adjust + $ make -j8 # if you have 8 CPU cores, otherwise adjust, use -j`nproc` for all cores Build with a custom namespace: @@ -70,7 +70,7 @@ setting :code:`NAMESPACE` option with cmake: $ mkdir build $ cd build $ cmake -DNAMESPACE=MyNamespace .. - $ make -j8 # if you have 8 CPU cores, otherwise adjust + $ make -j8 # if you have 8 CPU cores, otherwise adjust, use -j`nproc` for all cores Debug build with unit tests: @@ -80,7 +80,7 @@ Debug build with unit tests: $ mkdir build-debug $ cd build-debug $ cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON .. - $ make -j8 # if you have 8 CPU cores, otherwise adjust + $ make -j8 # if you have 8 CPU cores, otherwise adjust, use -j`nproc` for all cores $ make test # to run the tests Build with examples: @@ -91,13 +91,13 @@ Build with examples: $ mkdir build-examples $ cd build-examples $ cmake -DBUILD_EXAMPLES=ON .. - $ make -j8 # if you have 8 CPU cores, otherwise adjust + $ make -j8 # if you have 8 CPU cores, otherwise adjust, use -j`nproc` for all cores $ ./bgl_example # run the BGL example Install ^^^^^^^^^ -After the building, you can install the GraphAr C++ library with: +After the building, you can install the GraphAr C++ library with(run in directory you build, like build-relese, build and so on): .. code-block:: shell From 138d25ac8f905a85ae0fd7baecc64007beefc15c Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Jun 2023 12:46:36 +0800 Subject: [PATCH 2/4] Update README.rst --- cpp/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cpp/README.rst b/cpp/README.rst index dbf37e763..1014d0bd0 100644 --- a/cpp/README.rst +++ b/cpp/README.rst @@ -97,11 +97,11 @@ Build with examples: Install ^^^^^^^^^ -After the building, you can install the GraphAr C++ library with(run in directory you build, like build-relese, build and so on): +After the building, you can install the GraphAr C++ library with: .. code-block:: shell - $ sudo make install + $ sudo make install # run in directory you build, like build-relese, build and so on Generate API document ^^^^^^^^^^^^^^^^^^^^^ From 9d6aaf78634724ddc621993a3b4034d03dc14c49 Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Jun 2023 20:19:32 +0800 Subject: [PATCH 3/4] Update README.rst --- cpp/README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cpp/README.rst b/cpp/README.rst index 1014d0bd0..f59176f0a 100644 --- a/cpp/README.rst +++ b/cpp/README.rst @@ -43,7 +43,7 @@ Building All the instructions below assume that you have cloned the GraphAr git repository and navigated to the ``cpp`` subdirectory: -.. code-block:: +.. code-block:: shell $ git clone https://github.com/alibaba/GraphAr.git $ cd GraphAr @@ -52,7 +52,7 @@ repository and navigated to the ``cpp`` subdirectory: Release build: -.. code-block:: +.. code-block:: shell $ mkdir build-release $ cd build-release @@ -101,7 +101,7 @@ After the building, you can install the GraphAr C++ library with: .. code-block:: shell - $ sudo make install # run in directory you build, like build-relese, build and so on + $ sudo make install # run in directory you build, like build-release, build and so on Generate API document ^^^^^^^^^^^^^^^^^^^^^ From e99bb77130262286312c186438588bd1332049d8 Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Jun 2023 20:20:54 +0800 Subject: [PATCH 4/4] Update README.rst --- spark/README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/spark/README.rst b/spark/README.rst index ee1120101..99e497d90 100644 --- a/spark/README.rst +++ b/spark/README.rst @@ -24,7 +24,7 @@ Building All the instructions below assume that you have cloned the GraphAr git repository and navigated to the ``spark`` subdirectory: -.. code-block:: +.. code-block:: shell $ git clone https://github.com/alibaba/GraphAr.git $ cd GraphAr @@ -33,7 +33,7 @@ repository and navigated to the ``spark`` subdirectory: Build the package: -.. code-block:: +.. code-block:: shell $ mvn clean package -DskipTests @@ -42,19 +42,19 @@ After compilation, the package file graphar-x.x.x-SNAPSHOT-shaded.jar is generat Build the package and run the unit tests: -.. code-block:: +.. code-block:: shell $ mvn clean package Build and run the unit tests: -.. code-block:: +.. code-block:: shell $ mvn clean test Build and run certain unit test: -.. code-block:: +.. code-block:: shell $ mvn clean test -Dsuites='com.alibaba.graphar.GraphInfoSuite' # run the GraphInfo test suite $ mvn clean test -Dsuites='com.alibaba.graphar.GraphInfoSuite load graph info' # run the `load graph info` test of test suite