[PATCH 0/3] libtracefs documentation fixes

[PATCH 0/3] libtracefs documentation fixes

[Daniel Bristot de Oliveira]

I started using libtracefs last week, and I am really impressed!

While learning about it, I ended up finding three small issues
in the documentation, here they are.

Daniel Bristot de Oliveira (3):
  libtracefs: Fix example in libtracefs-events-tep
  libtracefs: Fix example in libtracefs-events
  libtracefs: Fix a typo in libtracefs-files

 Documentation/libtracefs-events-tep.txt | 2 +-
 Documentation/libtracefs-events.txt     | 2 +-
 Documentation/libtracefs-files.txt      | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

-- 
2.31.1

[PATCH 1/3] libtracefs: Fix example in libtracefs-events-tep

[Daniel Bristot de Oliveira]

tracefs_local_events() returns struct tep_handle *, instead of
struct tep_event *. Fix the example.

Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
---
 Documentation/libtracefs-events-tep.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/libtracefs-events-tep.txt b/Documentation/libtracefs-events-tep.txt
index 4c5cb21..752e830 100644
--- a/Documentation/libtracefs-events-tep.txt
+++ b/Documentation/libtracefs-events-tep.txt
@@ -73,7 +73,7 @@ EXAMPLE
 --
 #include <tracefs.h>
 
-struct tep_event *tep;
+struct tep_handle *tep;
 ...
 	tep = tracefs_local_events(NULL);
 	if (!tep) {
-- 
2.31.1

[PATCH 2/3] libtracefs: Fix example in libtracefs-events

[Daniel Bristot de Oliveira]

tracefs_local_events() returns struct tep_handle *, instead of
struct tep_event *. Fix the example.

Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
---
 Documentation/libtracefs-events.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/libtracefs-events.txt b/Documentation/libtracefs-events.txt
index 3fe9199..102728d 100644
--- a/Documentation/libtracefs-events.txt
+++ b/Documentation/libtracefs-events.txt
@@ -122,7 +122,7 @@ static int records_walk(struct tep_event *tep, struct tep_record *record, int cp
 	return 0;
 }
 ...
-struct tep_event *tep = tracefs_local_events(NULL);
+struct tep_handle *tep = tracefs_local_events(NULL);
 
 	if (!tep) {
 		/* Failed to initialise tep handler with local events */
-- 
2.31.1

[PATCH 3/3] libtracefs: Fix a typo in libtracefs-files

[Daniel Bristot de Oliveira]

s/trasefs/tracefs/

Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
---
 Documentation/libtracefs-files.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/libtracefs-files.txt b/Documentation/libtracefs-files.txt
index dc85f2d..d6da507 100644
--- a/Documentation/libtracefs-files.txt
+++ b/Documentation/libtracefs-files.txt
@@ -24,7 +24,7 @@ system mount point and trace files in it.
 
 The _tracefs_get_tracing_file()_ function returns the full path of the
 file with given _name_ in the trace file system. The function works
-only with files in the trasefs main directory, it is not trace instance
+only with files in the tracefs main directory, it is not trace instance
 aware. It is recommended to use _tracefs_instance_get_file()_ and
 _tracefs_instance_get_dir()_ instead. The returned string must be freed
 with _tracefs_put_tracing_file()_.
-- 
2.31.1

Re: [PATCH 0/3] libtracefs documentation fixes

[Steven Rostedt]

On Thu, 29 Jul 2021 16:50:07 +0200
Daniel Bristot de Oliveira <bristot@kernel.org> wrote:

> I started using libtracefs last week, and I am really impressed!
> 
> While learning about it, I ended up finding three small issues
> in the documentation, here they are.
> 
> Daniel Bristot de Oliveira (3):
>   libtracefs: Fix example in libtracefs-events-tep
>   libtracefs: Fix example in libtracefs-events
>   libtracefs: Fix a typo in libtracefs-files
> 
>

Thanks Daniel, I'll queue these up for my next push.

-- Steve