Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add basic manpage #257

Merged
merged 2 commits into from
Jan 18, 2020
Merged

Add basic manpage #257

merged 2 commits into from
Jan 18, 2020

Conversation

cadeef
Copy link
Contributor

@cadeef cadeef commented Jan 11, 2020

Addresses #212
This manpage is loosely converted from help2man and then modified to convention.

sharkdp
sharkdp reviewed Jan 12, 2020
View reviewed changes
Copy link
Owner

@sharkdp sharkdp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much! This looks great.

I added a few inline comments.

We should also add the manpage file to the before_deploy.bash script such that it will be included in the tarballs and Debian packages. This should work similar to what we do in fd:

doc/hyperfine.1 Outdated Show resolved Hide resolved
doc/hyperfine.1 Outdated
.RE
.LP
Perform a benchmark of 'grep' with a warm disk cache by first running the command
3 times:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe: "… with a warm disk cache by performing 3 runs upfront that are not part of the measurement"?

@cadeef
Address code review:
107638f 
  * 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)
sharkdp
sharkdp approved these changes Jan 18, 2020
View reviewed changes
Copy link
Owner

@sharkdp sharkdp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much!

@sharkdp sharkdp merged commit e595be7 into sharkdp:master Jan 18, 2020
@sharkdp sharkdp mentioned this pull request Jan 18, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharkdp sharkdp sharkdp approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cadeef @sharkdp