Skip to content

docs: updates and new manual page for pcp-htop#705

Merged
natoscott merged 2 commits intohtop-dev:masterfrom
natoscott:pcp-htop-manual
Aug 13, 2021
Merged

docs: updates and new manual page for pcp-htop#705
natoscott merged 2 commits intohtop-dev:masterfrom
natoscott:pcp-htop-manual

Conversation

@natoscott
Copy link
Copy Markdown
Member

Add some words about pcp-htop to the main man page, and add a
new man page describing the pcp-htop configuration files that
allow new meters and columns to be defined at runtime.

@natoscott natoscott added documentation 📖 Improvements or additions to documentation PCP PCP related issues labels Jul 23, 2021
@natoscott natoscott added this to the 3.1.0 milestone Jul 23, 2021
Copy link
Copy Markdown
Member

@BenBE BenBE left a comment

Choose a reason for hiding this comment

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

Wrapping single/few words to next line makes this unnecessarily hard to read.

Comment thread pcp-htop.5.in
Comment thread pcp-htop.5.in
Comment thread pcp-htop.5.in Outdated
Comment thread pcp-htop.5.in
Comment thread pcp-htop.5.in
Comment thread pcp-htop.5.in
Comment thread pcp-htop.5.in Outdated
@smalinux
Copy link
Copy Markdown
Contributor

Related #669 #707 #536

@BenBE
Copy link
Copy Markdown
Member

BenBE commented Jul 28, 2021

@natoscott Does it make sense to merge this way before #707 lands?

Comment thread pcp-htop.5.in
@natoscott
Copy link
Copy Markdown
Member Author

@natoscott Does it make sense to merge this way before #707 lands?

It doesn't really matter once we're sure of the file formats, default values, and so on I guess. We're getting close with #707 now, it's working pretty well for me and we have lots of useful additional columns. So, either before or after should be fine from now on IMO - I don't have a strong preference.

@natoscott
Copy link
Copy Markdown
Member Author

Wrapping single/few words to next line makes this unnecessarily hard to read.

Happy to tweak things further but not sure what lines specifically this comment refers to... ?

Copy link
Copy Markdown
Member

@BenBE BenBE left a comment

Choose a reason for hiding this comment

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

@natoscott Marked up some locations where there are only 1-3 words on a new line, where they technically didn't need to. Was worse in previous versions.

Comment thread pcp-htop.5.in Outdated
Comment thread pcp-htop.5.in Outdated
Comment thread pcp-htop.5.in Outdated
@natoscott
Copy link
Copy Markdown
Member Author

@natoscott Marked up some locations where there are only 1-3 words on a new line, where they technically didn't need to. Was worse in previous versions.

Ah, I see what you mean now. I'll fix those cases you mention up and do a quick audit of the rest of the file - thanks.

Add some words about pcp-htop to the main man page, and add a
new man page describing the pcp-htop configuration files that
allow new meters and columns to be defined at runtime.
Copy link
Copy Markdown
Member

@BenBE BenBE left a comment

Choose a reason for hiding this comment

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

Just some small changes left …

Comment thread pcp-htop.5.in Outdated
Comment thread htop.1.in Outdated
Comment thread pcp-htop.5.in Outdated
Comment thread pcp-htop.5.in Outdated
Co-authored-by: BenBE <BenBE@geshi.org>
@natoscott natoscott merged commit 9a07ba2 into htop-dev:master Aug 13, 2021
@natoscott natoscott deleted the pcp-htop-manual branch August 13, 2021 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📖 Improvements or additions to documentation PCP PCP related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants