Skip to content

Commit 3f944fe

Browse files
committed
Update README.md
1 parent cc25314 commit 3f944fe

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -287,24 +287,25 @@ as the target accuracy is not exceeded. Halving is made possible by the fact
287287
that the table encodes hashes for 8 windows at offsets from the start of the
288288
pattern, corresponding to the 8 bits per index hashing table cell. Combining
289289
the two halves of the table may flip some bits to zero from one, which may
290-
cause a false positive match. This proves the monotonicity of the indexer.
290+
cause a false positive match. This proves the monotonicity of the indexer. A
291+
zero bit hash value indicates a possible match.
291292

292-
The ugrep-indexer understands "binary files", which can be ignored and not
293-
indexed with ugrep-indexer option `-I` (`--ignore-binary`). This is useful
294-
when searching with ugrep option `-I` (`--ignore-binary`) to ignore binary
295-
files, which is a typical scenario.
293+
The ugrep-indexer detects "binary files", which can be ignored and not indexed
294+
with ugrep-indexer option `-I` (`--ignore-binary`). This is useful when
295+
searching with ugrep option `-I` (`--ignore-binary`) to ignore binary files,
296+
which is a typical scenario.
296297

297-
The ugrep-indexer also supports .gitignore files (and similar), specified with
298-
ugrep-indexer option `-X` (`--ignore-files`). Ignored files and directories
299-
will not be indexed to save file system space. This works well when searching
300-
for files with ugrep option `--ignore-files`.
298+
The ugrep-indexer obeys .gitignore file exclusions when specified with option
299+
`-X` (`--ignore-files`). Ignored files and directories will not be indexed to
300+
save file system space. This works well when searching for files with ugrep
301+
option `--ignore-files`.
301302

302303
Indexing can be aborted, for example with CTRL-C, which will not result in a
303304
loss of search capability with ugrep, but will leave the directory structure
304305
only partially indexed.
305306

306307
Option `-c` checks indexes for stale references and non-indexed files and
307-
directories. Run ugrep-indexer again to incrementally update all indexes.
308+
directories.
308309

309310
Indexes are deleted with ugrep-indexer option `-d`.
310311

0 commit comments

Comments
 (0)