rikhuijzer 4acbd4446d [MLIR][Doc] Also print summarys for passes on a newline ... This patch is improves upon https://reviews.llvm.org/D152621. There, I pointed out some issues with D152621, which I'll repeat here. > Passes use a different logic for generating the documentation; which I didn't update to be in-line with this change. Fixed by defining and using `mlir::tblgen::emitSummary`. This is now used in `OpDocGen.cpp` and `PassDocGen.cpp`. Note that the passes documentation currently prints the summary behind the pass argument. For example: ``` #### -arm-neon-2d-to-intr: Convert Arm NEON structured ops to intrinsics ``` at https://mlir.llvm.org/docs/Passes/#-promote-buffers-to-stack-promotes-heap-based-allocations-to-automatically-managed-stack-based-allocations. This currently differs from how the summary is printed for Ops. For example: ``` #### amdgpu.lds_barrier (::mlir::amdgpu::LDSBarrierOp) ¶ **Summary:** _Barrier that includes a wait for LDS memory operations._ ``` at https://mlir.llvm.org/docs/Dialects/AMDGPU/#amdgpulds_barrier-mliramdgpuldsbarrierop. The changes in this patch ensure that: 1. The summary is always printed on a new line. 2. The summary is always printed in italic. 3. The summary always starts with a capital letter. I've dropped the `**Summary:**`, which was introduced in D152621, because only italicization should be already clear enough. > `amx.tdpbssd` shows **Summary:** __ meaning that apparently hasSummary does not guarantee a non-empty summary. This is fixed by double-checking `!summary.empty()`, because the following code ```cpp void mlir::tblgen::emitSummary(StringRef summary, raw_ostream &os) { if (!summary.empty()) { char first = std::toupper(summary.front()); llvm::StringRef rest = summary.drop_front(); os << "\n_" << first << rest << "_\n\n"; } else { os << "\n_" << "foo" << "_\n\n"; } } ``` generates the following Markdown: ``` ### `amx.tdpbssd` (::mlir::amx::x86_amx_tdpbssd) _foo_ ``` in `tools/mlir/docs/Dialects/AMX.md`. > Summary fields containing * cancel the italicization, so the * should probably be escaped to solve this. EDIT: Nope. This is because mlir-www runs Hugo 0.80 whereas 0.111 correctly parses _Raw Buffer Floating-point Atomic Add (MI-* only)_ as an italicized string. This will be fixed by https://github.com/llvm/mlir-www/pull/152. Reviewed By: jpienaar Differential Revision: https://reviews.llvm.org/D152648		2023-06-13 09:26:11 +02:00
..
mlir-cpu-runner	[mlir-cpu-runner] Add export_executable_symbols in CMake	2023-04-07 14:40:57 +00:00
mlir-linalg-ods-gen	[mlir] Move tblgen code generation to use functional forms of cast/isa	2023-05-26 07:47:03 +02:00
mlir-lsp-server
mlir-opt	[mlir] Add support for "promised" interfaces	2023-06-09 11:30:13 -07:00
mlir-parser-fuzzer
mlir-pdll
mlir-pdll-lsp-server
mlir-reduce
mlir-shlib
mlir-spirv-cpu-runner	[mlir][GPU] Rename MLIRGPUOps CMake target to MLIRGPUDialect	2023-05-16 14:25:08 +02:00
mlir-tblgen	[MLIR][Doc] Also print summarys for passes on a newline	2023-06-13 09:26:11 +02:00
mlir-translate
mlir-vulkan-runner	[MLIR] Removes CMake work-arounds.	2023-06-07 17:47:10 +02:00
tblgen-lsp-server
CMakeLists.txt