From d8017c7febc2ade190eeebf6f03c4d88626bd6b5 Mon Sep 17 00:00:00 2001 From: Fabian Neuschmidt Date: Fri, 12 Jun 2015 02:27:40 +0200 Subject: [PATCH] Globbing: Add globbing documentation Fixes https://github.com/coala-analyzer/coala/issues/396 --- docs/Glob_Patterns.md | 31 +++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 32 insertions(+) create mode 100644 docs/Glob_Patterns.md diff --git a/docs/Glob_Patterns.md b/docs/Glob_Patterns.md new file mode 100644 index 0000000000..ff39e4cc24 --- /dev/null +++ b/docs/Glob_Patterns.md @@ -0,0 +1,31 @@ +# Glob - Extended unix style pathname expansion + +In coala, files and directories are specified by file name. To allow input of +multiple files without requiring a large number of filenames, coala supports +a number of wildcards. These are based on the unix-style glob syntax and they +are *not* the same as regular expressions. + +## Syntax + +The special characters used in shell-style wildcards are: + +``` ++-----------------+-----------------------------------------------------------+ +| PATTERN | MEANING | ++=================+===========================================================+ +| '[seq]' | Matches any character in seq. Cannot be empty. Any special| +| | character looses its special meaning in a set. | ++-----------------+-----------------------------------------------------------+ +| '[!seq]' | Matches any character not in seq. Cannot be empty. Any | +| | special character looses its special meaning in a set. | ++-----------------+-----------------------------------------------------------+ +| '(seq_a|seq_b)' | Matches either sequence_a or sequence_b as a whole. More | +| | than two or just one sequence can be given. | ++-----------------+-----------------------------------------------------------+ +| '?' | Matches any single character. | ++-----------------+-----------------------------------------------------------+ +| '*' | Matches everything but the directory separator | ++-----------------+-----------------------------------------------------------+ +| '**' | Matches everything. | ++-----------------+-----------------------------------------------------------+ +``` diff --git a/mkdocs.yml b/mkdocs.yml index 88d6daa896..af67eea796 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,7 @@ pages: - 'Introduction': 'index.md' - 'Installation': 'Install.md' - 'Tutorial': 'Tutorial.md' + - 'Glob Patterns': 'Glob_Patterns.md' - 'Exit Codes': 'Exit_Codes.md' - Getting Involved: - 'Introduction': 'Getting_Involved/README.md'