[llvm] 4a46fd5 - [GlobPattern][docs] Fix poorly rendered docs
Ellis Hoag via llvm-commits
llvm-commits at lists.llvm.org
Mon Sep 11 09:23:57 PDT 2023
Author: Ellis Hoag
Date: 2023-09-11T09:23:49-07:00
New Revision: 4a46fd543908b183efe2a78ec6dec4dd25fdc591
URL: https://github.com/llvm/llvm-project/commit/4a46fd543908b183efe2a78ec6dec4dd25fdc591
DIFF: https://github.com/llvm/llvm-project/commit/4a46fd543908b183efe2a78ec6dec4dd25fdc591.diff
LOG: [GlobPattern][docs] Fix poorly rendered docs
In #65397 I attempted to fix these docs by adding a "." but that didn't
seem to work. This tries to use two newlines to divide paragraphs.
Added:
Modified:
llvm/include/llvm/Support/GlobPattern.h
Removed:
################################################################################
diff --git a/llvm/include/llvm/Support/GlobPattern.h b/llvm/include/llvm/Support/GlobPattern.h
index 5a64d3ae729397e..1a722e65bed8024 100644
--- a/llvm/include/llvm/Support/GlobPattern.h
+++ b/llvm/include/llvm/Support/GlobPattern.h
@@ -35,7 +35,8 @@ namespace llvm {
/// brace expansions are not supported and characters \p "{,}" are treated as
/// literals.
/// * \p "\" escapes the next character so it is treated as a literal.
-/// .
+///
+///
/// Some known edge cases are:
/// * \p "]" is allowed as the first character in a character class, i.e.,
/// \p "[]]" is valid and matches the literal \p "]".
@@ -43,7 +44,8 @@ namespace llvm {
/// * Empty or singleton brace expansions, e.g., \p "{}", \p "{a}", are invalid.
/// * \p "}" and \p "," that are not inside a brace expansion are taken as
/// literals, e.g., \p ",}" is valid but \p "{" is not.
-/// .
+///
+///
/// For example, \p "*[/\\]foo.{c,cpp}" will match (unix or windows) paths to
/// all files named \p "foo.c" or \p "foo.cpp".
class GlobPattern {
More information about the llvm-commits
mailing list