public inbox for gcc-cvs@sourceware.org
help / color / mirror / Atom feed
From: Jonathan Wakely <redi@gcc.gnu.org>
To: gcc-cvs@gcc.gnu.org, libstdc++-cvs@gcc.gnu.org
Subject: [gcc r13-7267] libstdc++: Strip absolute paths from files shown in Doxygen docs
Date: Fri, 28 Apr 2023 13:10:47 +0000 (GMT)	[thread overview]
Message-ID: <20230428131047.4493F3857733@sourceware.org> (raw)

https://gcc.gnu.org/g:bf9e62a9210d3d7756a6cf81607bb3ea80c5f8f7

commit r13-7267-gbf9e62a9210d3d7756a6cf81607bb3ea80c5f8f7
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Fri Apr 28 11:22:26 2023 +0100

    libstdc++: Strip absolute paths from files shown in Doxygen docs
    
    This avoids showing absolute paths from the expansion of
    @srcdir@/libsupc++/ in the doxygen File List view.
    
    libstdc++-v3/ChangeLog:
    
            * doc/doxygen/user.cfg.in (STRIP_FROM_PATH): Remove prefixes
            from header paths.
    
    (cherry picked from commit 975e8e836ead0e9055a125a2a23463db5d847cb3)

Diff:
---
 libstdc++-v3/doc/doxygen/user.cfg.in | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libstdc++-v3/doc/doxygen/user.cfg.in b/libstdc++-v3/doc/doxygen/user.cfg.in
index 9d814af8614..ed260520690 100644
--- a/libstdc++-v3/doc/doxygen/user.cfg.in
+++ b/libstdc++-v3/doc/doxygen/user.cfg.in
@@ -152,7 +152,7 @@ FULL_PATH_NAMES        = NO
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = @srcdir@/doc/ @srcdir@/libsupc++/ include/
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -837,6 +837,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
+# N.B. update STRIP_FROM_PATH to sanitize paths outside the build tree.
 INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
                          @srcdir@/libsupc++/compare \
                          @srcdir@/libsupc++/cxxabi.h \

                 reply	other threads:[~2023-04-28 13:10 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230428131047.4493F3857733@sourceware.org \
    --to=redi@gcc.gnu.org \
    --cc=gcc-cvs@gcc.gnu.org \
    --cc=libstdc++-cvs@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).