sharkdp/hyperfine
1
1
Fork 0
mirror of https://github.com/sharkdp/hyperfine.git synced 2024-11-26 03:25:46 +03:00
Code Issues Projects Releases Wiki Activity

Address code review:

Browse Source 
* Update basic benchmark example
  * Clarify warm up example
  * Add manpage to generated tarballs and debs (bit of YOLO here, need to spin an instance to verify build output but the additions as modeled from fd are innocuous)
This commit is contained in:
Cade Ekblad-Frank 2020-01-16 14:08:05 -06:00 committed by David Peter
parent 5911e1ca4b
commit e595be7d5a
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ci/before_deploy.bash
View File

@ -23,7 +23,8 @@ pack() {
cp "target/$TARGET/release/$PROJECT_NAME" "$tempdir/$package_name/"
strip "$tempdir/$package_name/$PROJECT_NAME"
# readme and license
# manpage, readme and license
cp "doc/$PROJECT_NAME.1" "$tempdir/$package_name"
cp README.md "$tempdir/$package_name"
cp LICENSE-MIT "$tempdir/$package_name"
cp LICENSE-APACHE "$tempdir/$package_name"
@ -69,6 +70,10 @@ make_deb() {
install -Dm755 "target/$TARGET/release/$PROJECT_NAME" "$tempdir/usr/bin/$PROJECT_NAME"
strip "$tempdir/usr/bin/$PROJECT_NAME"
# manpage
install -Dm644 "doc/$PROJECT_NAME.1" "$tempdir/usr/share/man/man1/$PROJECT_NAME.1"
gzip --best "$tempdir/usr/share/man/man1/$PROJECT_NAME.1"
# readme and license
install -Dm644 README.md "$tempdir/usr/share/doc/$PROJECT_NAME/README.md"
install -Dm644 LICENSE-MIT "$tempdir/usr/share/doc/$PROJECT_NAME/LICENSE-MIT"

8
doc/hyperfine.1
View File

@ -173,10 +173,10 @@ Print help message.
Show version information.
.SH EXAMPLES
.LP
Basic benchmark of 'find . -iname '*[0-9].jpg'':
Basic benchmark of 'find . -name todo.txt':
.RS
.nf
\fBhyperfine\fR 'find . -iname '*[0-9].jpg''
\fBhyperfine\fR 'find . -name todo.txt'
.fi
.RE
.LP
@ -187,8 +187,8 @@ Perform benchmarks for 'sleep 0.2' and 'sleep 3.2' with a minimum 5 runs each:
.fi
.RE
.LP
Perform a benchmark of 'grep' with a warm disk cache by first running the command
3 times:
Perform a benchmark of 'grep' with a warm disk cache by executing 3 runs up front that are not part
of the measurement:
.RS
.nf
\fBhyperfine\fR \fB\-\-warmup\fR 3 'grep -R TODO *'