This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: [PATCH] Port Doxygen support script from Perl to Python; add unittests
- From: Martin Liška <mliska at suse dot cz>
- To: David Malcolm <dmalcolm at redhat dot com>, gcc-patches at gcc dot gnu dot org
- Cc: Jeff Law <law at redhat dot com>
- Date: Wed, 31 May 2017 16:10:26 +0200
- Subject: Re: [PATCH] Port Doxygen support script from Perl to Python; add unittests
- Authentication-results: sourceware.org; auth=none
- References: <CAD_=9DQv_8bgSxpPNGyHTYsRgCvM77fQikY6eN_-MSHG6bmqbg@mail.gmail.com> <1489715500-63153-1-git-send-email-dmalcolm@redhat.com> <1493417340.9106.160.camel@redhat.com> <1495827156.9289.75.camel@redhat.com> <3ecc005d-a99a-8fd0-38fa-8d2128c88574@suse.cz> <329c72e0-cb17-178b-3858-d080b5b27457@suse.cz>
..adding missing patch
>From 3021b695a8111e1552176529ab3342cdd2ae3a43 Mon Sep 17 00:00:00 2001
From: marxin <mliska@suse.cz>
Date: Wed, 3 May 2017 11:42:41 +0200
Subject: [PATCH] Doxygen: add default location for filters and output folder.
contrib/ChangeLog:
2017-05-03 Martin Liska <mliska@suse.cz>
* gcc.doxy: Add default location for filters and output folder.
* filter_gcc_for_doxygen_new: Rename to filter_gcc_for_doxygen.
* filter_params.pl: Remove.
---
contrib/filter_gcc_for_doxygen | 6 +++---
contrib/filter_gcc_for_doxygen_new | 12 ------------
contrib/filter_params.pl | 14 --------------
contrib/gcc.doxy | 8 ++------
4 files changed, 5 insertions(+), 35 deletions(-)
delete mode 100755 contrib/filter_gcc_for_doxygen_new
delete mode 100755 contrib/filter_params.pl
diff --git a/contrib/filter_gcc_for_doxygen b/contrib/filter_gcc_for_doxygen
index 3787eebbf0e..d1109a50c88 100755
--- a/contrib/filter_gcc_for_doxygen
+++ b/contrib/filter_gcc_for_doxygen
@@ -1,12 +1,12 @@
#!/bin/sh
# This filters GCC source before Doxygen can get confused by it;
-# this script is listed in the doxyfile. The output is not very
+# this script is listed in the doxyfile. The output is not very
# pretty, but at least we get output that Doxygen can understand.
#
-# $1 is a source file of some kind. The source we wish doxygen to
+# $1 is a source file of some kind. The source we wish doxygen to
# process is put on stdout.
dir=`dirname $0`
-perl $dir/filter_params.pl < $1 | perl $dir/filter_knr2ansi.pl
+python $dir/filter_params.py $1
exit 0
diff --git a/contrib/filter_gcc_for_doxygen_new b/contrib/filter_gcc_for_doxygen_new
deleted file mode 100755
index d1109a50c88..00000000000
--- a/contrib/filter_gcc_for_doxygen_new
+++ /dev/null
@@ -1,12 +0,0 @@
-#!/bin/sh
-
-# This filters GCC source before Doxygen can get confused by it;
-# this script is listed in the doxyfile. The output is not very
-# pretty, but at least we get output that Doxygen can understand.
-#
-# $1 is a source file of some kind. The source we wish doxygen to
-# process is put on stdout.
-
-dir=`dirname $0`
-python $dir/filter_params.py $1
-exit 0
diff --git a/contrib/filter_params.pl b/contrib/filter_params.pl
deleted file mode 100755
index 22dae6cc561..00000000000
--- a/contrib/filter_params.pl
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/usr/bin/perl
-
-# Filters out some of the #defines used throughout the GCC sources:
-# - GTY(()) marks declarations for gengtype.c
-# - PARAMS(()) is used for K&R compatibility. See ansidecl.h.
-
-while (<>) {
- s/^\/\* /\/\*\* \@verbatim /;
- s/\*\// \@endverbatim \*\//;
- s/GTY[ \t]*\(\(.*\)\)//g;
- s/[ \t]ATTRIBUTE_UNUSED//g;
- s/PARAMS[ \t]*\(\((.*?)\)\)/\($1\)/sg;
- print;
-}
diff --git a/contrib/gcc.doxy b/contrib/gcc.doxy
index 7a284e754aa..a8eeb03c9a0 100644
--- a/contrib/gcc.doxy
+++ b/contrib/gcc.doxy
@@ -11,16 +11,12 @@
# Values that contain spaces should be placed between quotes (" ")
-#-----------------------------------------------------------------------------
-# NOTE: YOU MUST EDIT THE FOLLOWING HARDWIRED PATHS BEFORE USING THIS FILE.
-#-----------------------------------------------------------------------------
-
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
+OUTPUT_DIRECTORY = gcc-doxygen
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -30,7 +26,7 @@ OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
# to standard output. If FILTER_PATTERNS is specified, this tag will be
# ignored.
-INPUT_FILTER = @INPUT_FILTER@
+INPUT_FILTER = contrib/filter_gcc_for_doxygen
#-----------------------------------------------------------------------------
--
2.12.2