From ae28456299d1656916ed017c2edcfcae01d33243 Mon Sep 17 00:00:00 2001 From: Cody Balos Date: Tue, 16 Apr 2024 11:08:32 -0700 Subject: [PATCH 1/2] Apply suggestions from code review Co-authored-by: David Gardner --- CONTRIBUTING.md | 6 +++--- doc/shared/sundials/Install.rst | 2 +- doc/superbuild/source/contributing/index.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fe46d779c..4106e3738b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,7 @@ By making a contribution to this project, I certify that: ``` The DCO lets us know that you are entitled to contribute this code to -[SUNDIALS] and that you are willing to have it used in distributions and +SUNDIALS and that you are willing to have it used in distributions and derivative works. By including the DCO signature, you are stating that one or @@ -110,9 +110,9 @@ and they **are not maintained by the SUNDIALS team**. To create a SUNDIALS addon and use it there are a few things you need to do: -1. In your addon project, ensure that you have a `CMakeLists.txt` that uses +1. In your addon project, ensure that you have a `CMakeLists.txt` that uses the `sundials_add_library` CMake macro to create the library target. The best thing to do is simply - copy from, or refer to, a CMakeLists.txt in the SUNDIALS `src` directory. + copy from, or refer to, a `CMakeLists.txt` in the SUNDIALS `src` directory. 2. Follow the steps in the `README.md` file in the `external/` directory in the root of the SUNDIALS source code. diff --git a/doc/shared/sundials/Install.rst b/doc/shared/sundials/Install.rst index d19427a400..8c2ed50c2e 100644 --- a/doc/shared/sundials/Install.rst +++ b/doc/shared/sundials/Install.rst @@ -2209,5 +2209,5 @@ To build with SUNDIALS addons, 1. Clone/copy the addon(s) into ``/external/`` 2. Copy the ``sundials-addon-example`` block in the ``/external/CMakeLists.txt``, paste it below the example block, and modify the path listed for your own external addon(s). -3. When building SUNDIALS, set the CMake option :cmakeop:`SUNDIALS_ENABLE_EXTERNAL_ADDONS` to ON +3. When building SUNDIALS, set the CMake option :cmakeop:`SUNDIALS_ENABLE_EXTERNAL_ADDONS` to `ON` 4. Build SUNDIALS as usual. diff --git a/doc/superbuild/source/contributing/index.rst b/doc/superbuild/source/contributing/index.rst index a6b64e7975..7edf32c404 100644 --- a/doc/superbuild/source/contributing/index.rst +++ b/doc/superbuild/source/contributing/index.rst @@ -138,9 +138,9 @@ Creating an addon To create a SUNDIALS addon and use it there are a few things you need to do: -1. In your addon project, ensure that you have a ``CMakeLists.txt`` that uses +1. In your addon project, ensure that you have a ``CMakeLists.txt`` that uses the ``sundials_add_library`` CMake macro to create the library target. The best thing to do is simply - copy from, or refer to, a CMakeLists.txt in the SUNDIALS ``src`` directory. + copy from, or refer to, a ``CMakeLists.txt`` in the SUNDIALS ``src`` directory. 2. Follow the steps in the ``README.md`` file in the ``external/`` directory in the root of the SUNDIALS source code. From f6727452dbfba79ed56b13458d466961afa0fbfa Mon Sep 17 00:00:00 2001 From: Cody Balos Date: Tue, 16 Apr 2024 11:08:49 -0700 Subject: [PATCH 2/2] Update doc/superbuild/source/contributing/index.rst Co-authored-by: David Gardner --- doc/superbuild/source/contributing/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/superbuild/source/contributing/index.rst b/doc/superbuild/source/contributing/index.rst index 7edf32c404..947443d9f5 100644 --- a/doc/superbuild/source/contributing/index.rst +++ b/doc/superbuild/source/contributing/index.rst @@ -117,9 +117,9 @@ off line in the commit message: Replacing Jane Doe’s details with your name and email address. -If you've set `user.name` and `user.email` in your Git configuration, you can +If you've set ``user.name`` and ``user.email`` in your Git configuration, you can automatically add a sign off line at the end of the commit message by using the -`-s` option (e.g., `git commit -s`). +``-s`` option (e.g., ``git commit -s``). Contributions via SUNDIALS Addons