[PATCH v2 06/13] grep & rev-list doc: stop promising libpcre for --perl-regexp
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Apr 19, 2017, 22:40 UTC
- Message-ID
- <20170419224053.8920-7-avarab@gmail.com>
- In-Reply-To
- <20170419224053.8920-1-avarab@gmail.com>
Stop promising in our grep & rev-list options documentation that we're always going to be using libpcre when given the --perl-regexp option.
Instead talk about using "Perl-compatible regular expressions" and using "the PCRE library". Saying "libpcre" strongly suggests that we might be talking about libpcre.so, which is always going to be v1.
Not only do does the documentation now align more clearly with future plans, but it should be more easily readable to the layman.
This is for preparation for libpcre2 support, which in the future may be powering the --perl-regexp option by default, depending on how Git is compiled.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> --- Documentation/git-grep.txt | 4 ++-- Documentation/rev-list-options.txt | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 71f32f3508..e42ba83c42 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -161,8 +161,8 @@ OPTIONS -P:: --perl-regexp:: - Use Perl-compatible regexp for patterns. Requires libpcre to be - compiled in. + Use Perl-compatible regular expressions for patterns. Uses the + PCRE library, which Git needs to be compiled against. -F:: --fixed-strings:: diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 5b7fa49a7f..565cde636e 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -93,8 +93,9 @@ endif::git-rev-list[] -P:: --perl-regexp:: - Consider the limiting patterns to be Perl-compatible regular expressions. - Requires libpcre to be compiled in. + Consider the limiting patterns to be Perl-compatible regular + expressions. Uses the PCRE library, which Git needs to be + compiled against. --remove-empty:: Stop when a given path disappears from the tree.
-- 2.11.0