Update website for profiling 2.6.0

gap-packages · Aug 27, 2024 · 37d3eda · 37d3eda
1 parent 6fc2ea4
commit 37d3eda
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 48 deletions.
diff --git a/PackageInfo.g b/PackageInfo.g
@@ -10,8 +10,8 @@ SetPackageInfo( rec(
 
 PackageName := "profiling",
 Subtitle := "Line by line profiling and code coverage for GAP",
-Version := "2.5.4",
-Date := "29/06/2023", # dd/mm/yyyy format
+Version := "2.6.0",
+Date := "27/08/2024", # dd/mm/yyyy format
 License := "MIT AND CDDL-1.0",
 
 Persons := [
@@ -69,20 +69,21 @@ PackageDoc := rec(
 ),
 
 Dependencies := rec(
-  GAP := ">= 4.10",
+  GAP := ">= 4.12",
   NeededOtherPackages := [ [ "GAPDoc", ">= 1.5" ], ["IO", ">= 4.4.4" ] ],
   SuggestedOtherPackages := [ ],
   ExternalConditions := [ ],
 ),
 
 AvailabilityTest := function()
-        local so_exists;
-        so_exists := (Filename(DirectoriesPackagePrograms("profiling"), "profiling.so") <> fail);
-        if not(so_exists) then
-          Info(InfoWarning, 1, "Kernel extension not built for profiling package");
-        fi;
-        return so_exists;
-    end,
+  if not IsKernelExtensionAvailable("profiling") then
+    LogPackageLoadingMessage(PACKAGE_WARNING,
+                             ["the kernel module is not compiled, ",
+                              "the package cannot be loaded."]);
+    return fail;
+  fi;
+  return true;
+end,
 
 TestFile := "tst/testall.g",
 

diff --git a/_data/package.yml b/_data/package.yml
@@ -1,7 +1,7 @@
 name: profiling
-version: "2.5.4"
+version: "2.6.0"
 license: "MIT AND CDDL-1.0"
-date: 2023-06-29
+date: 2024-08-27
 description: |
     Line by line profiling and code coverage for GAP
 
@@ -13,12 +13,12 @@ maintainers:
     - name: Christopher Jefferson
       url: https://caj.host.cs.st-andrews.ac.uk/
 
-GAP: ">= 4.10"
+GAP: ">= 4.12"
 
 needed-pkgs:
     - name: "GAPDoc"
       version: ">= 1.5"
-      url: "http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc"
+      url: "https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc"
     - name: "IO"
       version: ">= 4.4.4"
       url: "https://gap-packages.github.io/io"
@@ -29,7 +29,7 @@ packageinfo: https://gap-packages.github.io/profiling/PackageInfo.g
 
 downloads:
     - name: .tar.gz
-      url: https://github.com/gap-packages/profiling/releases/download/v2.5.4/profiling-2.5.4.tar.gz
+      url: https://github.com/gap-packages/profiling/releases/download/v2.6.0/profiling-2.6.0.tar.gz
 
 abstract: |
 
@@ -38,26 +38,26 @@ doc-html: doc/chap0_mj.html
 doc-pdf: doc/manual.pdf
 citeas: |
     <p class='BibEntry'>
-    [<span class='BibKey'>Jef23</span>]   <b class='BibAuthor'>Jefferson, C.</b>,
+    [<span class='BibKey'>Jef24</span>]   <b class='BibAuthor'>Jefferson, C.</b>,
      <i class='BibTitle'>profiling, Line by line profiling and code coverage for GAP,
-             Version 2.5.4</i>
-     (<span class='BibYear'>2023</span>)<br />
+             Version 2.6.0</i>
+     (<span class='BibYear'>2024</span>)<br />
     (<span class='BibNote'>GAP package</span>),
     <span class='BibHowpublished'><a href="https://gap-packages.github.io/profiling/">https://gap-packages.github.io/profiling/</a></span>.
     </p>
     
 
 bibtex: |
-    @misc{ profiling2.5.4,
+    @misc{ profiling,
       author =           {Jefferson, C.},
       title =            {{profiling},  Line by line profiling and code coverage
-                          for GAP, {V}ersion 2.5.4},
-      month =            {Jun},
-      year =             {2023},
+                          for GAP, {V}ersion 2.6.0},
+      month =            {Aug},
+      year =             {2024},
       note =             {GAP package},
       howpublished =     {\href      {https://gap-packages.github.io/profiling/}
-                          {\texttt{https://gap-packages.github.io/}\discretionary
+                          {\texttt{https://gap\texttt{\symbol{45}}packages.github.io/}\discretionary
                           {}{}{}\texttt{profiling/}}},
-      printedkey =       {Jef23}
+      printedkey =       {Jef24}
     }
 
diff --git a/doc/chap0.html b/doc/chap0.html
@@ -29,10 +29,10 @@ <h1>profiling</h1>
 <h2>Line by line profiling and code coverage for <strong class="pkg">GAP</strong></h2>
 
 <p>
-    2.5.4</p>
+    2.6.0</p>
 
 <p>
-    29 June 2023
+    27 August 2024
   </p>
 
 </div>
@@ -103,6 +103,6 @@ <h3>Contents<a id="contents" name="contents"></a></h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap0.txt b/doc/chap0.txt
@@ -6,10 +6,10 @@
                [1X Line by line profiling and code coverage for [5XGAP[105X [101X
 
 
-                                     2.5.4
+                                     2.6.0
 
 
-                                  29 June 2023
+                                 27 August 2024
 
 
                              Christopher Jefferson

diff --git a/doc/chap0_mj.html b/doc/chap0_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (profiling) - Contents</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -32,10 +32,10 @@ <h1>profiling</h1>
 <h2>Line by line profiling and code coverage for <strong class="pkg">GAP</strong></h2>
 
 <p>
-    2.5.4</p>
+    2.6.0</p>
 
 <p>
-    29 June 2023
+    27 August 2024
   </p>
 
 </div>
@@ -106,6 +106,6 @@ <h3>Contents<a id="contents" name="contents"></a></h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap1.html b/doc/chap1.html
@@ -149,6 +149,6 @@ <h4>1.3 <span class="Heading">Function-based profiling</span></h4>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap1_mj.html b/doc/chap1_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (profiling) - Chapter 1: Tutorial</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -152,6 +152,6 @@ <h4>1.3 <span class="Heading">Function-based profiling</span></h4>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap2.html b/doc/chap2.html
@@ -88,7 +88,7 @@ <h5>2.2-1 OutputFlameGraph</h5>
 
 <p>The flame graph will be written to <var class="Arg">filename</var> (or returned as a string if <var class="Arg">filename</var> is not present).</p>
 
-<p>The final (optional) argument is a record of options. Currently, the allowed options are 'squash' (which is a boolean). If 'squash' is true then recursive functions calls will be squashed, so the graph will not show recursive functions calling themselves. The other allowed option is 'type', which can be "default" (a standard flamegraph), "reverse" (reverse the graph, showing the leaf functions first), and "chart" (where the graph shows the flow of time from left-to-right, rather than merging all calls from one function to another into one block).</p>
+<p>The final (optional) argument is a record of options. Currently, the allowed options are 'squash' (which is a boolean). If 'squash' is true then recursive functions calls will be squashed, so the graph will not show recursive functions calling themselves. The other allowed option is 'type', which can be "default" (a standard flamegraph) or "reverse" (reverse the graph, showing the leaf functions first)</p>
 
 <p><a id="X7C6110C180DE1785" name="X7C6110C180DE1785"></a></p>
 
@@ -208,6 +208,6 @@ <h5>2.4-3 ProfilePackage</h5>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chap2.txt b/doc/chap2.txt
@@ -46,10 +46,8 @@
   options  are  'squash'  (which  is  a  boolean).  If  'squash'  is true then
   recursive  functions  calls  will  be  squashed,  so the graph will not show
   recursive  functions calling themselves. The other allowed option is 'type',
-  which  can  be  "default"  (a  standard  flamegraph), "reverse" (reverse the
-  graph, showing the leaf functions first), and "chart" (where the graph shows
-  the  flow of time from left-to-right, rather than merging all calls from one
-  function to another into one block).[133X
+  which  can  be  "default"  (a standard flamegraph) or "reverse" (reverse the
+  graph, showing the leaf functions first)[133X
 
   [1X2.2-2 OutputFlameGraphInput[101X
 

diff --git a/doc/chap2_mj.html b/doc/chap2_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (profiling) - Chapter 2: Functionality provided by the profiling package</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -91,7 +91,7 @@ <h5>2.2-1 OutputFlameGraph</h5>
 
 <p>The flame graph will be written to <var class="Arg">filename</var> (or returned as a string if <var class="Arg">filename</var> is not present).</p>
 
-<p>The final (optional) argument is a record of options. Currently, the allowed options are 'squash' (which is a boolean). If 'squash' is true then recursive functions calls will be squashed, so the graph will not show recursive functions calling themselves. The other allowed option is 'type', which can be "default" (a standard flamegraph), "reverse" (reverse the graph, showing the leaf functions first), and "chart" (where the graph shows the flow of time from left-to-right, rather than merging all calls from one function to another into one block).</p>
+<p>The final (optional) argument is a record of options. Currently, the allowed options are 'squash' (which is a boolean). If 'squash' is true then recursive functions calls will be squashed, so the graph will not show recursive functions calling themselves. The other allowed option is 'type', which can be "default" (a standard flamegraph) or "reverse" (reverse the graph, showing the leaf functions first)</p>
 
 <p><a id="X7C6110C180DE1785" name="X7C6110C180DE1785"></a></p>
 
@@ -211,6 +211,6 @@ <h5>2.4-3 ProfilePackage</h5>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chapInd.html b/doc/chapInd.html
@@ -45,6 +45,6 @@ <h3>Index</h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chapInd.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>
diff --git a/doc/chapInd_mj.html b/doc/chapInd_mj.html
@@ -6,7 +6,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <script type="text/javascript"
-  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
 </script>
 <title>GAP (profiling) - Index</title>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
@@ -48,6 +48,6 @@ <h3>Index</h3>
 <div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a>  <a href="chap1_mj.html">1</a>  <a href="chap2_mj.html">2</a>  <a href="chapInd_mj.html">Ind</a>  </div>
 
 <hr />
-<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
+<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
 </body>
 </html>