This is an archive of the discontinued LLVM Phabricator instance.

Differential D125258

[docs][pp-trace] Remove FileNotFound callback
ClosedPublic

Authored by oToToT on May 9 2022, 12:16 PM.

Details

Reviewers
jansvoboda11
Commits
rGba7b6f46b37b: [docs][pp-trace] Remove FileNotFound callback
Summary

FileNotFound preprocessor callback is removed in D119708.
We should also remove it from the documentation.

Diff Detail

Event Timeline

oToToT created this revision.May 9 2022, 12:16 PM
Herald added a project: Restricted Project. · View Herald TranscriptMay 9 2022, 12:16 PM
oToToT requested review of this revision.May 9 2022, 12:16 PM
Herald added a project: Restricted Project. · View Herald TranscriptMay 9 2022, 12:16 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B163538: Diff 428157.May 9 2022, 2:05 PM
jansvoboda11 accepted this revision.May 11 2022, 2:52 AM

LGTM, thanks!

This revision is now accepted and ready to land.May 11 2022, 2:52 AM
Closed by commit rGba7b6f46b37b: [docs][pp-trace] Remove FileNotFound callback (authored by oToToT). · Explain WhyMay 11 2022, 3:14 AM
This revision was automatically updated to reflect the committed changes.
oToToT added a commit: rGba7b6f46b37b: [docs][pp-trace] Remove FileNotFound callback.
Hahnfeld mentioned this in D142196: [clang][Lex] Add back PPCallbacks::FileNotFound.Jan 23 2023, 3:25 PM

Revision Contents

PathSize
clang-tools-extra/
docs/
21 lines

Diff 428607

clang-tools-extra/docs/pp-trace.rst

Show First 20 Lines • Show All 43 Lines • ▼ Show 20 Lines.. option:: -callbacks <comma-separated-globs>
This option specifies a comma-separated list of globs describing the list of This option specifies a comma-separated list of globs describing the list of
callbacks that should be traced. Globs are processed in order of appearance. callbacks that should be traced. Globs are processed in order of appearance.
Positive globs add matched callbacks to the set, netative globs (those with Positive globs add matched callbacks to the set, netative globs (those with
the '-' prefix) remove callacks from the set. the '-' prefix) remove callacks from the set.
* FileChanged * FileChanged
* FileSkipped * FileSkipped
* FileNotFound
* InclusionDirective * InclusionDirective
* moduleImport * moduleImport
* EndOfMainFile * EndOfMainFile
* Ident * Ident
* PragmaDirective * PragmaDirective
* PragmaComment * PragmaComment
* PragmaDetectMismatch * PragmaDetectMismatch
* PragmaDebug * PragmaDebug
▲ Show 20 Lines • Show All 134 Lines • ▼ Show 20 Lines
Example::: Example:::
- Callback: FileSkipped - Callback: FileSkipped
ParentFile: "/path/filename.h" ParentFile: "/path/filename.h"
FilenameTok: "filename.h" FilenameTok: "filename.h"
FileType: C_User FileType: C_User
`FileNotFound <https://clang.llvm.org/doxygen/classclang_1_1PPCallbacks.html#a3045151545f987256bfa8d978916ef00>`_ Callback
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFound is called when an inclusion directive results in a file-not-found error.
Argument descriptions:
============== ================================================== ============================== =====================================================================================================================================
Argument Name Argument Value Syntax Clang C++ Type Description
============== ================================================== ============================== =====================================================================================================================================
FileName "(file)" StringRef The name of the file being included, as written in the source code.
RecoveryPath (path) SmallVectorImpl<char> If this client indicates that it can recover from this missing file, the client should set this as an additional header search patch.
============== ================================================== ============================== =====================================================================================================================================
Example:::
- Callback: FileNotFound
FileName: "/path/filename.h"
RecoveryPath:
`InclusionDirective <https://clang.llvm.org/doxygen/classclang_1_1PPCallbacks.html#a557d9738c329793513a6f57d6b60de52>`_ Callback `InclusionDirective <https://clang.llvm.org/doxygen/classclang_1_1PPCallbacks.html#a557d9738c329793513a6f57d6b60de52>`_ Callback
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
InclusionDirective is called when an inclusion directive of any kind (#include</code>, #import</code>, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion. InclusionDirective is called when an inclusion directive of any kind (#include</code>, #import</code>, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion.
Argument descriptions: Argument descriptions:
============== ================================================== ============================== ============================================================================================================ ============== ================================================== ============================== ============================================================================================================
▲ Show 20 Lines • Show All 594 Lines • Show Last 20 Lines