Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
* libtraceevent internal functions
@ 2020-09-21  4:22 Tzvetomir Stoyanov
  2020-09-23  7:47 ` Tzvetomir Stoyanov
  0 siblings, 1 reply; 3+ messages in thread
From: Tzvetomir Stoyanov @ 2020-09-21  4:22 UTC (permalink / raw)
  To: Steven Rostedt; +Cc: Linux Trace Devel

Hi Steven,
While I was working to hide non API libtraceevent functions from the
users, as Ben Hutchings suggested, I found these - they are declared
as official APIs in event-parse.h, but are not described in the man
pages. We should decide - are they APIs, so we should add them into
the man pages, or are internal functions and we should hide them.
   tep_peek_char
   tep_load_plugins_hook
   tep_print_printk
   tep_buffer_init
   tep_get_input_buf_ptr
   tep_get_input_buf
   tep_read_token
   tep_set_test_filters
   tep_add_plugin_path
   tep_plugin_print_options
   tep_free_token
   tep_print_funcs

-- 
Tzvetomir (Ceco) Stoyanov
VMware Open Source Technology Center

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: libtraceevent internal functions
  2020-09-21  4:22 libtraceevent internal functions Tzvetomir Stoyanov
@ 2020-09-23  7:47 ` Tzvetomir Stoyanov
  2020-09-23 15:24   ` Steven Rostedt
  0 siblings, 1 reply; 3+ messages in thread
From: Tzvetomir Stoyanov @ 2020-09-23  7:47 UTC (permalink / raw)
  To: Steven Rostedt; +Cc: Linux Trace Devel

Hi Steven, I did a quick research of these functions. Some of them
should be library APIs and some should be internal only
That is what I found:

These are used only in the library, going to hide them:
   tep_peek_char
   tep_buffer_init
   tep_get_input_buf_ptr
   tep_get_input_buf
   tep_read_token
   tep_free_token

These are used by perf and trace-cmd, going to add a man page for them:
   tep_print_printk
   tep_add_plugin_path
   tep_print_funcs

These are not used anywhere yet, but look like APIs, going to add a
man page for them:
  tep_set_test_filters
  tep_plugin_print_options

This one is already an API with man page, it is in the list by mistake
  tep_load_plugins_hook


On Mon, Sep 21, 2020 at 7:22 AM Tzvetomir Stoyanov
<tz.stoyanov@gmail.com> wrote:
>
> Hi Steven,
> While I was working to hide non API libtraceevent functions from the
> users, as Ben Hutchings suggested, I found these - they are declared
> as official APIs in event-parse.h, but are not described in the man
> pages. We should decide - are they APIs, so we should add them into
> the man pages, or are internal functions and we should hide them.
>    tep_peek_char
>    tep_load_plugins_hook
>    tep_print_printk
>    tep_buffer_init
>    tep_get_input_buf_ptr
>    tep_get_input_buf
>    tep_read_token
>    tep_set_test_filters
>    tep_add_plugin_path
>    tep_plugin_print_options
>    tep_free_token
>    tep_print_funcs
>
> --
> Tzvetomir (Ceco) Stoyanov
> VMware Open Source Technology Center



-- 
Tzvetomir (Ceco) Stoyanov
VMware Open Source Technology Center

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: libtraceevent internal functions
  2020-09-23  7:47 ` Tzvetomir Stoyanov
@ 2020-09-23 15:24   ` Steven Rostedt
  0 siblings, 0 replies; 3+ messages in thread
From: Steven Rostedt @ 2020-09-23 15:24 UTC (permalink / raw)
  To: Tzvetomir Stoyanov; +Cc: Linux Trace Devel

On Wed, 23 Sep 2020 10:47:43 +0300
Tzvetomir Stoyanov <tz.stoyanov@gmail.com> wrote:

> Hi Steven, I did a quick research of these functions. Some of them
> should be library APIs and some should be internal only
> That is what I found:
> 
> These are used only in the library, going to hide them:
>    tep_peek_char
>    tep_buffer_init
>    tep_get_input_buf_ptr
>    tep_get_input_buf
>    tep_read_token
>    tep_free_token
> 
> These are used by perf and trace-cmd, going to add a man page for them:
>    tep_print_printk
>    tep_add_plugin_path
>    tep_print_funcs
> 
> These are not used anywhere yet, but look like APIs, going to add a
> man page for them:
>   tep_set_test_filters
>   tep_plugin_print_options
> 
> This one is already an API with man page, it is in the list by mistake
>   tep_load_plugins_hook
> 

Hi Ceco,

Looks good. Thanks for the update.

-- Steve

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, back to index

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-21  4:22 libtraceevent internal functions Tzvetomir Stoyanov
2020-09-23  7:47 ` Tzvetomir Stoyanov
2020-09-23 15:24   ` Steven Rostedt

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git