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

Update configuration/options summary in svg #61

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

Conversation

jamuir
Copy link

@jamuir jamuir commented Jan 28, 2025

Some of the comments summarizing the configuration/options could be confusing. E.g., "f" was used for "Filtering", but "-f" is the command-line option used to specify the sample frequency. Also, "hz" was used but there is no command-line option or config directive that mentions "hertz".

Change the summmary to use the names from the config file. Update the sample config file so it is more obvious what is parsed as a float, and also include "Cmdline", which was missing.

Some of the comments summarizing the configuration/options could be
confusing.  E.g., "f" was used for "Filtering", but "-f" is the
command-line option used to specify the sample frequency.  Also, "hz"
was used but there is no command-line option or config directive that
mentions "hertz".

Change the summmary to use the names from the config file.  Update the
sample config file so it is more obvious what is parsed as a float,
and also include "Cmdline", which was missing.
@jamuir
Copy link
Author

jamuir commented Jan 28, 2025

Here is what the updated summary looks like:

<!-- This file is a bootchart SVG file. It is best rendered in a browser -->
<!-- such as Chrome, Chromium, or Firefox. Other applications that       -->
<!-- render these files properly but more slowly are ImageMagick, gimp,  -->
<!-- inkscape, etc. To display the files on your system, just point      -->
<!-- your browser to file:///run/log (the default location) and click.   -->

<!-- This file was generated by bootchart version 235, running with configuration:  -->

<!-- Samples=300 -->
<!-- Frequency=10.000000 -->
<!-- Relative=0 -->
<!-- Filter=1 -->
<!-- Output=/tmp -->
<!-- Init=/usr/lib/systemd/systemd -->
<!-- PlotMemoryUsage=0 -->
<!-- PlotEntropyGraph=0 -->
<!-- ScaleX=100.000000 -->
<!-- ScaleY=20.000000 -->
<!-- ControlGroup=0 -->
<!-- PerCPU=0 -->
<!-- Cmdline=1 -->

Note that the quotes around the values have been dropped.

Copy link
Contributor

@sofar sofar left a comment

Choose a reason for hiding this comment

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

No comments from my side. These are all reasonable changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants