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.

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

Change sidebar load formatting to be consistent. #3013

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

Murph9000
Copy link

round() is not a good function to use for formatting, as it produces inconsistent results by truncating trailing zeroes. printf() produces consistent results with an appropriate format.

The format string used here is equivalent to library/uptime.c in procps, producing output equivalent to /usr/bin/uptime on Debian.

Thank you for your contribution to the Pi-hole Community!

Please read the comments below to help us consider your Pull Request.

We are all volunteers and completing the process outlined will help us review your commits quicker.

Please make sure you

  1. Base your code and PRs against the repositories developmental branch.
  2. Sign Off all commits as we enforce the DCO for all contributions
  3. Sign all your commits as they must have verified signatures
  4. File a pull request for any change that requires changes to our documentation at our documentation repo

What does this PR aim to accomplish?:

The system load shown in the web sidebar has inconsistent formatting, in that trailing zeroes are stripped. By long standing convention, Unix/Linux load average is presented as number rounded to 2 decimal places. Breaking from this convention can be viewed as visually ugly to veteran users; and potentially confusing for novices who may think something extra is being conveyed by the variation in formatting.

How does this PR accomplish the above?:

This moves the formatting being performed by round(), which is not intended to be used for visual formatting, to vprintf(). There is no need to round the numbers being passed around within the scripts, it is sufficient to use the automatic rounding provided by vprintf(). This change makes the load in the sidebar consistent with the output from /usr/bin/uptime on Debian (which is, in turn, consistent with the historical Unix uptime command).

Link documentation PRs if any are needed to support this PR:


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.

  • I have read the above and my PR is ready for review. Check this box to confirm

round() is not a good function to use for formatting, as it produces
inconsistent results by truncating trailing zeroes.
printf() produces consistent results with an appropriate format.

The format string used here is equivalent to library/uptime.c in
procps, producing output equivalent to /usr/bin/uptime on Debian.

Signed-off-by: Murph9000 <7693357+Murph9000@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant