Skip to contentSkip to conversation

kernel-shark-qt: Merge kshark_load_data_records/entries()

PATCH In review Steven Rostedt 2 participants 4 messages Jul 3, 2018 – Jul 4, 2018

lore
Share & tools
lore
#0 lore raw

cover kernel-shark-qt: Merge kshark_load_data_records/entries()

This works to consolidate the functions kshark_load_data_records() with kshark_load_data_entries(). It adds some helper functions for the two to use to simplify the code.

Note, doxygen warns that struct rec_list is not documented. Really? Such a simple structure doesn't really require documentation. Is there a way to shut it up? Or I can just add code to say
/** Shut doxygen up! ;-)

Yordan, please review these.

Steven Rostedt (VMware) (3):
kernel-shark-qt: Move declarations to top in datafilter.c example
kernel-shark-qt: Consolidate load_data_entries and load_data_records
kernel-shark-qt: Add helper function to find the next_cpu in kshark_load_data_*()

----

 kernel-shark-qt/examples/datafilter.c |   5 +-
 kernel-shark-qt/src/libkshark.c       | 253 ++++++++++++++++++++--------------
 2 files changed, 151 insertions(+), 107 deletions(-)
#1 lore raw
Quoted 8 lines · Steven Rostedt

This works to consolidate the functions kshark_load_data_records() with kshark_load_data_entries(). It adds some helper functions for the two to use to simplify the code.

Note, doxygen warns that struct rec_list is not documented. Really? Such a simple structure doesn't really require documentation. Is there a way to shut it up? Or I can just add code to say
/** Shut doxygen up! ;-)

Yes, you can do

//! @cond Doxygen_Suppress

struct rec_list {
	struct pevent_record	*rec;
	struct rec_list		*next;
};

//! @endcond

Another solutions is to turn off all warnings. This can be done by adding

WARN_IF_UNDOCUMENTED = NO

to doc/dox_config

On the other hand, do we expect the normal users to build doxygen documentation, if this documentation is available at http://kernelshark.org? So maybe we can tolerate having some warnings.

Actually this reminds me that there is a third solution. We can make this warnings invisible for the normal users by redirecting the doxygen's stderr to a file.

What do you think?

Yordan

Quoted 12 lines

Yordan, please review these.

Steven Rostedt (VMware) (3):
kernel-shark-qt: Move declarations to top in datafilter.c example
kernel-shark-qt: Consolidate load_data_entries and load_data_records
kernel-shark-qt: Add helper function to find the next_cpu in kshark_load_data_*()

----

  kernel-shark-qt/examples/datafilter.c |   5 +-
  kernel-shark-qt/src/libkshark.c       | 253 ++++++++++++++++++++--------------
  2 files changed, 151 insertions(+), 107 deletions(-)
#2 lore raw

[Sorry for the top post, it's a US holiday]

Can we just disable warnings for structures? I'd like to keep the function warnings on.

-- Steve

Quoted 59 lines · Yordan Karadzhov (VMware)
Quoted 8 lines · Steven Rostedt

This works to consolidate the functions kshark_load_data_records() with kshark_load_data_entries(). It adds some helper functions for the two to use to simplify the code.

Note, doxygen warns that struct rec_list is not documented. Really? Such a simple structure doesn't really require documentation. Is there a way to shut it up? Or I can just add code to say
/** Shut doxygen up! ;-)

Yes, you can do

//! @cond Doxygen_Suppress

struct rec_list {
	struct pevent_record	*rec;
	struct rec_list		*next;
};

//! @endcond

Another solutions is to turn off all warnings. This can be done by adding

WARN_IF_UNDOCUMENTED = NO

to doc/dox_config

On the other hand, do we expect the normal users to build doxygen documentation, if this documentation is available at
http://kernelshark.org? So maybe we can tolerate having some warnings.

Actually this reminds me that there is a third solution. We can make this warnings invisible for the normal users by redirecting the doxygen's stderr to a file.

What do you think?

Yordan

Quoted 4 lines

Yordan, please review these.

Steven Rostedt (VMware) (3):
kernel-shark-qt: Move declarations to top in datafilter.c

example

Quoted 1 line

kernel-shark-qt: Consolidate load_data_entries and

load_data_records

Quoted 1 line

kernel-shark-qt: Add helper function to find the next_cpu in

kshark_load_data_*()

Quoted 4 lines

----

  kernel-shark-qt/examples/datafilter.c |   5 +-
  kernel-shark-qt/src/libkshark.c       | 253

++++++++++++++++++++--------------

Quoted 2 lines
  2 files changed, 151 insertions(+), 107 deletions(-)
Signature · 1 line
Sent from my Android device with K-9 Mail. Please excuse my brevity.
#3 lore raw
Quoted 3 lines · Steven Rostedt

[Sorry for the top post, it's a US holiday]

Can we just disable warnings for structures? I'd like to keep the function warnings on.

It looks like this is not possible. At least, I can't see such option in the manual.

Yordan

Quoted 65 lines

-- Steve

Quoted 59 lines · Yordan Karadzhov (VMware)
Quoted 8 lines · Steven Rostedt

This works to consolidate the functions kshark_load_data_records() with kshark_load_data_entries(). It adds some helper functions for the two to use to simplify the code.

Note, doxygen warns that struct rec_list is not documented. Really? Such a simple structure doesn't really require documentation. Is there a way to shut it up? Or I can just add code to say
/** Shut doxygen up! ;-)

Yes, you can do

//! @cond Doxygen_Suppress

struct rec_list {
	struct pevent_record	*rec;
	struct rec_list		*next;
};

//! @endcond

Another solutions is to turn off all warnings. This can be done by adding

WARN_IF_UNDOCUMENTED = NO

to doc/dox_config

On the other hand, do we expect the normal users to build doxygen documentation, if this documentation is available at
http://kernelshark.org? So maybe we can tolerate having some warnings.

Actually this reminds me that there is a third solution. We can make this warnings invisible for the normal users by redirecting the doxygen's stderr to a file.

What do you think?

Yordan

Quoted 4 lines

Yordan, please review these.

Steven Rostedt (VMware) (3):
kernel-shark-qt: Move declarations to top in datafilter.c

example

Quoted 1 line

kernel-shark-qt: Consolidate load_data_entries and

load_data_records

Quoted 1 line

kernel-shark-qt: Add helper function to find the next_cpu in

kshark_load_data_*()

Quoted 4 lines

----

   kernel-shark-qt/examples/datafilter.c |   5 +-
   kernel-shark-qt/src/libkshark.c       | 253

++++++++++++++++++++--------------

Quoted 2 lines
   2 files changed, 151 insertions(+), 107 deletions(-)