Andrew Gallant
a2907db2de
faq: update donation section to mention sponsorships
2023-11-21 19:05:58 -05:00
Andrew Gallant
470ad1d072
faq: rewrite the section on shell completions
2023-11-21 19:02:07 -05:00
Andrew Gallant
5dc424d302
doc: scrub mentions of asciidoc/asciidoctor
...
This optional dependency is now finally dropped. So ends a long journey
of trying to generate man pages in a lightweight and dependable way. The
only thing I could figure out how to make work reliably was to just
learn how to write roff myself. Yay.
2023-11-21 18:39:32 -05:00
Stefan VanBuren
8782f8200c
doc: add missing backtick in FAQ
...
PR #1723
2020-11-03 10:32:38 -05:00
Josh Soref
def993bad1
spelling: fix various misspellings
...
These were found by the check spelling action[1] and reported
here[2].
PR #1685
[1] - https://github.com/marketplace/actions/check-spelling
[2] - 6f02d05671 (commitcomment-42625778)
2020-09-22 10:29:16 -04:00
Andrew Gallant
f511849c81
doc: fix FAQ ordering
...
The actual answers were in a different order than the table of contents.
This commit corrects that. No content has been changed.
2020-09-13 09:33:14 -04:00
Andrew Gallant
e6e50054b0
doc: document cygwin path translation behavior
...
Kudos to @Pyker for posting more details about this.
Closes #1277
2020-09-13 09:29:28 -04:00
Martin Michlmayr
1b2c1dc675
doc: fix typos
...
PR #1605
2020-06-04 09:06:09 -04:00
Chayoung You
16a1221fc7
doc: use asciidoctor instead of a2x
...
AsciiDoc development is continued under asciidoctor. See
https://github.com/asciidoc/asciidoc .
We do however fallback to a2x if asciidoctor is not present. This is to
ease migration, but at some point, it's likely that support for a2x will
be dropped.
Originally reported downstream:
https://github.com/Homebrew/linuxbrew-core/issues/19885
Closes #1544
2020-05-08 23:24:40 -04:00
Andrew Gallant
ecec6147d1
doc: be more vague in the FAQ
...
The existing vagueness was not enough to prevent people from lawyering
me over it.
2020-02-22 09:13:31 -05:00
Andrew Gallant
cb0dfda936
faq: add section about donations
...
This is asked often enough that it's worth having a canonical answer.
2020-02-05 13:09:11 -05:00
Yevgen Antymyrov
8892bf648c
doc: fix typo in FAQ
2019-09-25 08:13:27 -04:00
Gerard de Melo
7b3fe6b325
doc: fix typo in FAQ
...
PR #1248
2019-04-16 08:32:30 -04:00
Andrew Gallant
5724391d39
doc: small updates to the FAQ and GUIDE
...
Notably, ripgrep can do multiline search now. We also update the
supported compression format list and replace deprecated flags like
`--sort-files` with `--sort path`.
2019-01-26 16:19:09 -05:00
Andrew Gallant
8f978a3cf7
doc: clarify and fix typo
...
Clarify that --byte-offset may be wrong if the source isn't being read
directly.
Also tweak the README a bit. And remove a damned Oxford comma.
2018-08-27 21:21:37 -04:00
Andrew Gallant
7ac9782970
doc: fix typo
2018-08-20 18:00:14 -04:00
Andrew Gallant
180054d7dc
doc: caveats
2018-08-20 17:58:29 -04:00
Andrew Gallant
87a627631c
doc: add section on PCRE2 performance
2018-08-20 17:34:45 -04:00
Andrew Gallant
bb110c1ebe
ripgrep: migrate to libripgrep
...
This commit does the work to delete the old `grep` crate and effectively
rewrite most of ripgrep core to use the new libripgrep crates. The new
`grep` crate is now a facade that collects the various crates that make
up libripgrep.
The most complex part of ripgrep core is now arguably the translation
between command line parameters and the library options, which is
ultimately where we want to be.
2018-08-20 07:10:19 -04:00
Kalle Samuels
1d09d4d31b
ripgrep: add support for lz4 decompression
...
This uses the lz4 binary for decompression.
Closes #898
2018-07-21 16:26:39 -04:00
Jeremy Day
8cb03941e6
doc: add search and replace faq
...
Closes #870
2018-04-23 17:45:26 -04:00
Andrew Gallant
4889d2d37c
doc: clarify licensing story
2018-02-22 19:01:43 -05:00
Andrew Gallant
cbebb010a7
doc: fix typos
2018-02-21 15:59:12 -05:00
Andrew Gallant
7098daf6a8
doc: "to rip" means "fast"
...
Answer the origin story of ripgrep's name.
2018-02-21 15:53:50 -05:00
Balaji Sivaraman
d57fc58081
termcolor: add underline support
...
This commit adds underline support to the termcolor crate, and
exposes it through ripgrep.
Fixes #798
2018-02-20 07:10:03 -05:00
Andrew Gallant
b8e6d50bbe
doc: add "grep replacement" question to FAQ
...
I am tired of being throwing "but ripgrep is marketed as a grep
replacement" in my face. Let's answer it once and for all.
2018-02-12 17:57:14 -05:00
Andrew Gallant
3effea0b7c
doc: add color FAQ entries
...
This commit adds FAQ entries about how to configure ripgrep's coloring,
and how to get true color support in Windows consoles.
2018-02-10 22:28:12 -05:00
Andrew Gallant
904c75bd30
doc: overhaul documentation
...
This commit cleans up the README and splits portions of it out into
a user guide (GUIDE.md) and a FAQ (FAQ.md). The README now provides a
small list of documentation "quick" links to various parts of the docs.
This commit also does a few other minor touchups.
2018-02-10 12:12:47 -05:00
