From e4c9d54bc871a1efe3aabbe0d1fb1118ecd226fa Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Tue, 6 Feb 2024 13:21:45 +0000 Subject: [PATCH] Add wildcard reminder to common problems list (#1378) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 1597205db..72880a414 100644 --- a/README.md +++ b/README.md @@ -495,6 +495,13 @@ Users [have reported](https://github.com/realm/jazzy/issues/1012) that error messages about symbols lacking USRs can be fixed by unsetting `LLVM_TARGET_TRIPLE_SUFFIX` as part of the run script. +**Warnings about matches and leftovers when using globs and wildcards** + +Some flags such as `--include` and `--documentation` support '*' characters as +wildcards. If you are using the CLI then you must make sure that your shell +does not itself try to interpret them, for example by quoting the token: use +`jazzy --documentation '*.md'` instead of `jazzy --documentation *.md`. + ### Installation Problems **Can't find header files / clang**