diff options
| author | Jan-Arve Saether <jan-arve.saether@nokia.com> | 2012-08-17 11:52:40 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-17 19:31:50 +0200 |
| commit | 526da72e991e11205436a6363b6cfb6948a0eb0c (patch) | |
| tree | 1fd22bbbeee38b4ea00ce0abf437b69385f4de9a /src/tools/qdoc/location.cpp | |
| parent | 8160ca6dfd5332993e22fc82597aac947f335ee6 (diff) | |
Fix a bug in qdocs handling of excludedirs
The bug was there because the way qdoc tries to exclude the directories
given in the "excludedirs" variable:
It did a simple string comparision on the candidate path (to include)
with every string in the "excludedirs" variable.
However, this did not work for all cases, since the paths are not
canonicalized.
For instance, the problem I faced was that the following qdocconf
fragment: (config file located in doc/qtwidgets.qdocconf)
sourcedirs += ..
excludedirs += snippets
Since qdoc would recursively parse all subfolders of sourcedirs, it
would at one point visit the snippets folder, but it would have the
relative path "../doc/snippets", which did not match with "snippets",
causing snippets to not be excluded.
In addition, it seems that qdoc tries hard not to use absolute paths
(maybe because of more human-friendly error messages). I therefore
chose to canonicalize the relative paths.
As a side-effect this also give a better output from qdoc, as
../doc/foo.qdoc:42: Missing link
will become
foo.qdoc:42: Missing link
Change-Id: If9c25fa569abd03542bd12675acd44d8f4e0282c
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/tools/qdoc/location.cpp')
| -rw-r--r-- | src/tools/qdoc/location.cpp | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/tools/qdoc/location.cpp b/src/tools/qdoc/location.cpp index 630bf64e538..272be502de0 100644 --- a/src/tools/qdoc/location.cpp +++ b/src/tools/qdoc/location.cpp @@ -43,6 +43,7 @@ #include "config.h" #include "location.h" +#include <qdir.h> #include <qregexp.h> #include <stdlib.h> #include <limits.h> @@ -225,6 +226,24 @@ QString Location::fileName() const return fp.mid(fp.lastIndexOf('/') + 1); } + +/*! + * \brief Returns \a path which is canonicalized and relative to the config file. + * + * QDir::relativeFilePath does not canonicalize the paths, so + * if the config file is located at qtbase\src\widgets\doc\qtwidgets.qdocconf + * and it has a reference to any ancestor folder (e.g. ".." or even "../doc") + * \param path + * \return + */ +QString Location::canonicalRelativePath(const QString &path) const +{ + QDir configFileDir(QFileInfo(filePath()).dir()); + QDir dir(path); + const QString canon = dir.canonicalPath(); + return configFileDir.relativeFilePath(canon); +} + /*! \fn int Location::lineNo() const Returns the current line number. Must not be called on an empty Location object. |