This is an archive of the discontinued LLVM Phabricator instance.

Differential D122623

[docs][misexpect][NFC] Fix malformed table in docs
ClosedPublic

Authored by paulkirth on Mar 28 2022, 4:52 PM.

Details

Reviewers
phosek
abrachet
leonardchan
gulfem
mysterymath
haowei
tejohnson
Commits
rGa427e18896de: [docs][misexpect][NFC] Fix malformed table in docs

Diff Detail

Event Timeline

paulkirth created this revision.Mar 28 2022, 4:52 PM
Herald added a project: Restricted Project. · View Herald TranscriptMar 28 2022, 4:52 PM
paulkirth requested review of this revision.Mar 28 2022, 4:52 PM
Herald added a project: Restricted Project. · View Herald TranscriptMar 28 2022, 4:52 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
paulkirth updated this revision to Diff 418735.Mar 28 2022, 4:54 PM

update table in clang docs too

Herald added a project: Restricted Project. · View Herald TranscriptMar 28 2022, 4:54 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript
paulkirth retitled this revision from [docs][misexpect] Fix malformed table in docs to [docs][misexpect][NFC] Fix malformed table in docs.Mar 28 2022, 4:59 PM
paulkirth added reviewers: phosek, abrachet, leonardchan, gulfem, mysterymath, haowei.
paulkirth added a reviewer: tejohnson.Mar 28 2022, 5:07 PM
abrachet accepted this revision.Mar 28 2022, 5:10 PM
This revision is now accepted and ready to land.Mar 28 2022, 5:10 PM
This revision was landed with ongoing or failed builds.Mar 28 2022, 5:14 PM
Closed by commit rGa427e18896de: [docs][misexpect][NFC] Fix malformed table in docs (authored by paulkirth). · Explain Why
This revision was automatically updated to reflect the committed changes.
paulkirth added a commit: rGa427e18896de: [docs][misexpect][NFC] Fix malformed table in docs.
paulkirth added a reverting change: rG6c77972bac7c: Revert "[docs][misexpect][NFC] Fix malformed table in docs".Mar 28 2022, 11:21 PM
Harbormaster completed remote builds in B156660: Diff 418735.Mar 29 2022, 7:44 PM

Revision Contents

PathSize
clang/
docs/
2 lines
llvm/
docs/
2 lines

Diff 418739

clang/docs/MisExpect.rst

Show First 20 Lines • Show All 58 Lines • ▼ Show 20 Lines.. option:: -fdiagnostic-misexpect-tolerance=N
``0.95 * Threshold`` ``0.95 * Threshold``
LLVM supports 4 types of profile formats: Frontend, IR, CS-IR, and LLVM supports 4 types of profile formats: Frontend, IR, CS-IR, and
Sampling. MisExpect Diagnostics are compatible with all Profiling formats. Sampling. MisExpect Diagnostics are compatible with all Profiling formats.
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| Profile Type | Description | | Profile Type | Description |
+================+======================================================================================+ +================+======================================================================================+
| Frontend | Profiling instrumentation added during compilation by the frontend, i.e. ``clang`` | | Frontend | Profiling instrumentation added during compilation by the frontend, i.e. ``clang`` |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| IR | Profiling instrumentation added during by the LLVM backend | | IR | Profiling instrumentation added during by the LLVM backend |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| CS-IR | Context Sensitive IR based profiles | | CS-IR | Context Sensitive IR based profiles |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| Sampling | Profiles collected through sampling with external tools, such as ``perf`` on Linux | | Sampling | Profiles collected through sampling with external tools, such as ``perf`` on Linux |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+

llvm/docs/MisExpect.rst

Show First 20 Lines • Show All 56 Lines • ▼ Show 20 Lines.. option:: -pgo-warn-misexpect
``llvm.expect`` intrinsics. ``llvm.expect`` intrinsics.
LLVM supports 4 types of profile formats: Frontend, IR, CS-IR, and LLVM supports 4 types of profile formats: Frontend, IR, CS-IR, and
Sampling. MisExpect Diagnostics are compatible with all Profiling formats. Sampling. MisExpect Diagnostics are compatible with all Profiling formats.
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| Profile Type | Description | | Profile Type | Description |
+================+======================================================================================+ +================+======================================================================================+
| Frontend | Profiling instrumentation added during compilation by the frontend, i.e. ``clang`` | | Frontend | Profiling instrumentation added during compilation by the frontend, i.e. ``clang`` |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| IR | Profiling instrumentation added during by the LLVM backend | | IR | Profiling instrumentation added during by the LLVM backend |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| CS-IR | Context Sensitive IR based profiles | | CS-IR | Context Sensitive IR based profiles |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+
| Sampling | Profiles collected through sampling with external tools, such as ``perf`` on Linux | | Sampling | Profiles collected through sampling with external tools, such as ``perf`` on Linux |
+----------------+--------------------------------------------------------------------------------------+ +----------------+--------------------------------------------------------------------------------------+