create/update doc/ref/user_pref_list.xml automatically (gap-system#…

…5681)
hulpke · Mar 18, 2024 · 203cc91 · 203cc91
1 parent 4f3a54b
commit 203cc91
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 358 deletions.
diff --git a/.gitignore b/.gitignore
@@ -66,6 +66,7 @@ doc/*/*.tex
 /doc/*/*.out
 doc/gapmacrodoc.example-1.tst
 doc/gapmacrodoc.idx
+doc/ref/user_pref_list.xml
 
 # GAP packages
 /bootstrap-pkg-full.tar.gz

diff --git a/doc/make_doc.in b/doc/make_doc.in
@@ -18,6 +18,7 @@ echo "--------------------"
 base:="@abs_top_srcdir@";;
 books:=["ref", "tut", "hpc", "dev"];;
 latexOpts := rec(Maintitlesize := "\\\\fontsize{36}{38}\\\\selectfont");;
+UpdateXMLForUserPreferences();
 for run in [1,2] do
   for book in books do
     path := Concatenation(base, "/doc/", book);

diff --git a/doc/ref/user_pref_list.xml b/doc/ref/user_pref_list.xml
diff --git a/lib/userpref.g b/lib/userpref.g
@@ -822,6 +822,24 @@ BindGlobal( "XMLForUserPreferences", function( pkgname )
     end );
 
 
+#############################################################################
+##
+#F  UpdateXMLForUserPreferences()
+##
+##  Update the file <F>doc/ref/user_pref_list.xml</F> if necessary.
+##
+BindGlobal( "UpdateXMLForUserPreferences", function()
+    local file, old, new;
+
+    file:= Filename(DirectoriesLibrary("doc")[1], "ref/user_pref_list.xml");
+    old:= StringFile(file);
+    new:= XMLForUserPreferences("GAP");
+    if old <> new then
+      FileString(file, new);
+    fi;
+    end );
+
+
 #############################################################################
 ##
 #F  WriteGapIniFile( [<dir>, ][true] )

diff --git a/tst/extractmanuals.g b/tst/extractmanuals.g
@@ -52,6 +52,7 @@ pathtodoc := DirectoriesLibrary("doc/ref");
 Read(Filename(pathtodoc, "makedocreldata.g"));
 GAPInfo.ManualDataRef.pathtodoc := pathtodoc;
 GAPInfo.ManualDataRef.pathtoroot := DirectoriesLibrary("");
+UpdateXMLForUserPreferences();
 WriteExamplesTst( testdir, GAPInfo.ManualDataRef );
 
 #