Skip to content

Commit

Permalink
README: missed -d
Browse files Browse the repository at this point in the history
  • Loading branch information
rurban committed May 5, 2024
1 parent 7e71b08 commit cb75c95
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,20 @@ Supported arguments for **-h**:
This is not as good as expected yet. Ensure that you use -msse4, -mcrc or
-march=native or similar for the much faster HW variant.

The number of iterations can be limited with **-i**. **nbperf**
outputs a function matching `uint32_t hash(const void * restrict, size_t)`
The number of iterations can be limited with **-i**.

**nbperf** outputs a function matching `uint32_t hash(const void * restrict, size_t)`
to stdout. The function expects the key length as second
argument, for strings not including the terminating NUL. It is the
responsibility of the caller to pass in only valid keys or compare the
resulting index to the key. The function name can be changed using
**-n _name_**. If the **-s** flag is specified, it will be static.
**-n _name_**.

If the **-s** flag is specified, it will be static.

If the **-d** flag is specified, the hash keys will be embdedded into
generated C source, and
the resulting key is checked against the input to rule out false positives.

If the **-f** flag is specified, hash fudging will be allowed. I.e.
slightly slower hashes.
Expand Down
2 changes: 2 additions & 0 deletions nbperf.1
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ See
.Pp
The number of iterations can be limited with
.Fl i .
.Pp
.Nm
outputs a function matching
.Ft uint32_t
Expand All @@ -161,6 +162,7 @@ It is the responsibility of the caller to pass in only valid keys or compare
the resulting index to the key.
The function name can be changed using
.Fl n Ar name .
.Pp
If the
.Fl s
flag is specified, it will be static.
Expand Down

0 comments on commit cb75c95

Please sign in to comment.