From d23fdd85bfcc69fd361e6431d4cf9fe601a23c36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Fri, 12 May 2023 19:44:58 +0200 Subject: [PATCH] update testsuite script to last doxygen version --- Documentation/doc/scripts/process_doc.sh | 34 +++++++++---------- Documentation/doc/scripts/testsuite.py | 20 +++++------ .../developer_scripts/run_doxygen_testsuite | 2 +- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/Documentation/doc/scripts/process_doc.sh b/Documentation/doc/scripts/process_doc.sh index a41940ee2fd..14db7216f36 100644 --- a/Documentation/doc/scripts/process_doc.sh +++ b/Documentation/doc/scripts/process_doc.sh @@ -1,22 +1,22 @@ #!/bin/bash if [ "$1" == '--help' ]; then - echo "Usage: $0 [publish_dir]" - echo "Compares the output of doxygen 1.8.13 and doxygen master to the one from doxygen 1.8.4, of this CGAL version, " + echo "Usage: $0 [publish_dir]" + echo "Compares the output of doxygen 1.9.6 and doxygen master to the one from doxygen 1.8.13, of this CGAL version, " echo "publish_dir is the path to the dir where the testsuite results are kept" echo "$0 must be called from doc/scripts" exit 0 fi -mkdir -p doc_1_8_4 mkdir -p doc_1_8_13 +mkdir -p doc_1_9_6 mkdir -p doc_master -PATH_TO_1_8_4="$1" -PATH_TO_1_8_13="$2" +PATH_TO_1_8_13="$1" +PATH_TO_1_9_6="$2" PUBLISH_DIR="$3" -DOXYGEN_1=$($PATH_TO_1_8_4 --version) -DOXYGEN_2=$($PATH_TO_1_8_13 --version) +DOXYGEN_1=$($PATH_TO_1_8_13 --version) +DOXYGEN_2=$($PATH_TO_1_9_6 --version) DO_COMPARE=TRUE PATH_TO_SCRIPTS=${PWD} @@ -52,17 +52,17 @@ cd $PATH_TO_SCRIPTS #scripts PATH_TO_MASTER="$PWD/doxygen_master/build/bin/doxygen" echo "done." -echo "comparing versions 1.8.4 and 1.8.13" -bash -$- test_doxygen_versions.sh $PATH_TO_1_8_4 $PATH_TO_1_8_13 $PWD/doc_1_8_4 $PWD/doc_1_8_13 $PUBLISH_DIR -if [ ! -d $PWD/doc_1_8_13/doc_log ]; then +echo "comparing versions 1.8.13 and 1.9.6" +bash -$- test_doxygen_versions.sh $PATH_TO_1_8_13 $PATH_TO_1_9_6 $PWD/doc_1_8_13 $PWD/doc_1_9_6 $PUBLISH_DIR +if [ ! -d $PWD/doc_1_9_6/doc_log ]; then echo "NO DOC LOGS." exit 1 fi mv diff.txt diff1.txt -echo "comparing versions 1.8.4 and master" +echo "comparing versions 1.8.13 and master" if [ "$DO_COMPARE" = "TRUE" ]; then - bash -$- test_doxygen_versions.sh $PATH_TO_1_8_4 $PATH_TO_MASTER $PWD/doc_1_8_4 $PWD/doc_master $PUBLISH_DIR + bash -$- test_doxygen_versions.sh $PATH_TO_1_8_13 $PATH_TO_MASTER $PWD/doc_1_8_13 $PWD/doc_master $PUBLISH_DIR fi if [ $? -ne 0 ] || [ "$DO_COMPARE" = "FALSE" ]; then DO_COMPARE=FALSE @@ -74,19 +74,19 @@ fi #update overview CGAL_NAME=$(cat cgal_version) if [ "$DO_COMPARE" = "TRUE" ]; then - python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_4/doc_output/ --output-dir2 $PWD/doc_1_8_13/doc_output/ --doc-log-dir1 $PWD/doc_1_8_4/doc_log/ \ - --doc-log-dir2 $PWD/doc_1_8_13/doc_log/ --doc-log-dir-master $PWD/doc_master/doc_log/ \ + python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_13/doc_output/ --output-dir2 $PWD/doc_1_9_6/doc_output/ --doc-log-dir1 $PWD/doc_1_8_13/doc_log/ \ + --doc-log-dir2 $PWD/doc_1_9_6/doc_log/ --doc-log-dir-master $PWD/doc_master/doc_log/ \ --publish $PUBLISH_DIR --diff1 $PWD/diff1.txt --diff2 $PWD/diff2.txt --master-dir $PWD/doc_master/doc_output/ \ --cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2" --master-describe "$MASTER_DESCRIBE" else echo "NO MASTER" - python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_4/doc_output/ --output-dir2 $PWD/doc_1_8_13/doc_output/ --doc-log-dir1 $PWD/doc_1_8_4/doc_log/ \ - --doc-log-dir2 $PWD/doc_1_8_13/doc_log/ --doc-log-dir-master $PWD/doc_master/ \ + python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_13/doc_output/ --output-dir2 $PWD/doc_1_9_6/doc_output/ --doc-log-dir1 $PWD/doc_1_8_13/doc_log/ \ + --doc-log-dir2 $PWD/doc_1_9_6/doc_log/ --doc-log-dir-master $PWD/doc_master/ \ --publish $PUBLISH_DIR --diff1 $PWD/diff1.txt \ --cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2" fi #clean-up -rm -rf ./doc_1_8_4 ./doc_1_8_13 ./doc_master #./doxygen_master +rm -rf ./doc_1_8_13 ./doc_1_9_6 ./doc_master #./doxygen_master rm ./diff1.txt ./cgal_version if [ -f ./diff2.txt ]; then rm ./diff2.txt diff --git a/Documentation/doc/scripts/testsuite.py b/Documentation/doc/scripts/testsuite.py index 89819f1e591..b509b4577bc 100755 --- a/Documentation/doc/scripts/testsuite.py +++ b/Documentation/doc/scripts/testsuite.py @@ -1,9 +1,9 @@ #!/usr/bin/env python3 # Copyright (c) 2012 GeometryFactory (France). All rights reserved. # All rights reserved. -# +# # This file is part of CGAL (www.cgal.org). -# +# # $URL$ # $Id$ # SPDX-License-Identifier: GPL-3.0-or-later @@ -74,7 +74,7 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;}

Doxygen Manual Results

''' page_footer=''' - + @@ -97,7 +97,7 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;} suffix = '' if args.doxygen_version2: suffix = args.doxygen_version2 - link2="\n
Documentation built with our fork of Doxygen {_suffix} (used for the official CGAL documentation)\n".format(_suffix=suffix) + link2="\n
Documentation built with our fork of Doxygen {_suffix} (used for the official CGAL documentation)\n".format(_suffix=suffix) suffix = '' if args.master_describe: suffix=args.master_describe @@ -205,9 +205,9 @@ def main(): parser.add_argument('--doxygen-version1', default ='', help='Specify this argument if you want to add a version number to the name of the link to the first documentation.') parser.add_argument('--doxygen-version2', default ='', help='Specify this argument if you want to add a version number to the name of the link to the second documentation.') parser.add_argument('--master-describe', default ='', help='Specify this argument if you want to add a suffix to the name of the link to the doxygen master documentation.') - + args = parser.parse_args() - + if args.cgal_version: version_string="CGAL-"+args.cgal_version version_date=datetime.datetime.now().strftime("%Y-%m-%d") @@ -255,7 +255,7 @@ def main(): try: with open(publish_dir + 'index.html') as f: pass except IOError as e: - print('No index.html in the publish directory found. Writing a skeleton.') + print('No index.html in the publish directory found. Writing a skeleton.') with open(publish_dir + 'index.html', 'w') as f: f.write('''
Doxygen 1.8.4Doxygen 1.8.13(official)Doxygen master
Doxygen 1.8.13(patched)Doxygen 1.9.6(patched)Doxygen master
Package Name Logs