From 6c108f0d09a604589da1354c423d5121739fadf8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Fri, 15 Dec 2023 16:45:00 +0100 Subject: [PATCH 1/4] chore(docs): add some words about Cairo 1.18 Closes #3521 --- docs/source/contributing/testing.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index 059e2ba30e..fead975ef3 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -5,6 +5,24 @@ If you are adding new features to manim, you should add appropriate tests for th manim from breaking at each change by checking that no other feature has been broken and/or been unintentionally modified. +.. warning:: + + The full test suite requires Cairo 1.18 in order to run all tests. + However, Cairo 1.18 may not be available from your package manager, + like ``apt``, and it is very likely that you have an older version installed, + e.g., 1.16. If you run tests with a version prior to 1.18, + many tests will be skipped. Those tests are not skipped in the online CI. + + If you want to run all tests locally, you need to install Cairo 1.18 or above. + You can do so by compiling Cairo from source: + + 1. download ``cairo-1.18.0.tar.xz`` from + `here `_. + and uncompress it; + 2. open the INSTALL file and follow the instruction (you might need to install + meson and ninja); + 3. run the tests suite and verify that the Cairo version is correct. + How Manim tests --------------- From 1121c09cf10711462269515239977b0c3dbdf4b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Fri, 15 Dec 2023 16:46:59 +0100 Subject: [PATCH 2/4] fix(docs): typo --- docs/source/contributing/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index fead975ef3..4429f67d9b 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -7,7 +7,7 @@ feature has been broken and/or been unintentionally modified. .. warning:: - The full test suite requires Cairo 1.18 in order to run all tests. + The full tests suite requires Cairo 1.18 in order to run all tests. However, Cairo 1.18 may not be available from your package manager, like ``apt``, and it is very likely that you have an older version installed, e.g., 1.16. If you run tests with a version prior to 1.18, From e989de580d6197f7b7c01abfaca38b0264477569 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Sat, 16 Dec 2023 17:45:24 +0100 Subject: [PATCH 3/4] Update testing.rst --- docs/source/contributing/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index 4429f67d9b..88a5855a14 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -19,7 +19,7 @@ feature has been broken and/or been unintentionally modified. 1. download ``cairo-1.18.0.tar.xz`` from `here `_. and uncompress it; - 2. open the INSTALL file and follow the instruction (you might need to install + 2. open the INSTALL file and follow the instructions (you might need to install meson and ninja); 3. run the tests suite and verify that the Cairo version is correct. From c165f18f14751c0d8a826ecf078dd9ef82890101 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Sat, 16 Dec 2023 17:45:50 +0100 Subject: [PATCH 4/4] Update testing.rst --- docs/source/contributing/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index 88a5855a14..dfc6a225f8 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -20,7 +20,7 @@ feature has been broken and/or been unintentionally modified. `here `_. and uncompress it; 2. open the INSTALL file and follow the instructions (you might need to install - meson and ninja); + ``meson`` and ``ninja``); 3. run the tests suite and verify that the Cairo version is correct. How Manim tests