Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Tzvetomir Stoyanov <tz.stoyanov@gmail.com>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: Linux Trace Devel <linux-trace-devel@vger.kernel.org>
Subject: Re: libtraceevent internal functions
Date: Wed, 23 Sep 2020 10:47:43 +0300
Message-ID: <CAPpZLN67R8C_bjxVp+x2kOJ4EpT3_TyTx=ZVz-WgWXFGhH2r+Q@mail.gmail.com> (raw)
In-Reply-To: <CAPpZLN5k-SRynd=q-dD4swu2qkqx3FE1_MLkB0x9bN=77hmsdA@mail.gmail.com>

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

  reply index

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-21  4:22 Tzvetomir Stoyanov
2020-09-23  7:47 ` Tzvetomir Stoyanov [this message]
2020-09-23 15:24   ` Steven Rostedt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAPpZLN67R8C_bjxVp+x2kOJ4EpT3_TyTx=ZVz-WgWXFGhH2r+Q@mail.gmail.com' \
    --to=tz.stoyanov@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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