Need to update some docs in IO Visor github


thnam
 

Hello All,

I am a student majored in Computer Science from Korea.

I want to be contributor in IO Visor project, so I'm reading all docs and source code in IO Visor webpage & Github.
While I read 'Contributing bcc/eBPF scripts' in github(https://github.com/iovisor/bcc/blob/master/CONTRIBUTING-SCRIPTS.md), I discovered something to need to be update.

This documents said that tracing/strlen_count.py is a Python program with embedded C, and tracing/bitehist.* are separate Python and C files.
But I can't find the bitehist.c file. I think that the source file that named by bitehist.py is also a Python program with embedded C such as strlen_count.py.

Examples

These are grouped into subdirectories (networking, tracing). Your example can either be a Python program with embedded C (eg, tracing/strlen_count.py), or separate Python and C files (eg, tracing/bitehist.*).

As said earlier: keep it short, neat, and documented (code comments).


If I misunderstand about it, please let me know where I can find the C files.




Best regards,

Taekho Nam



Affan Ahmed Syed <asyed@...>
 

Taekho,

good catch. You should go ahead edit a copy of the README.md with an
example that has both python and c files and put in a pull request (on
github). That should make you a contributor.

Affan

On Sun, Sep 25, 2016 at 8:28 PM, Taekho Nam via iovisor-dev
<iovisor-dev@...> wrote:
Hello All,

I am a student majored in Computer Science from Korea.

I want to be contributor in IO Visor project, so I'm reading all docs and
source code in IO Visor webpage & Github.
While I read 'Contributing bcc/eBPF scripts' in
github(https://github.com/iovisor/bcc/blob/master/CONTRIBUTING-SCRIPTS.md),
I discovered something to need to be update.

This documents said that tracing/strlen_count.py is a Python program with
embedded C, and tracing/bitehist.* are separate Python and C files.
But I can't find the bitehist.c file. I think that the source file that
named by bitehist.py is also a Python program with embedded C such as
strlen_count.py.

Examples

These are grouped into subdirectories (networking, tracing). Your example
can either be a Python program with embedded C (eg,
tracing/strlen_count.py), or separate Python and C files (eg,
tracing/bitehist.*).

As said earlier: keep it short, neat, and documented (code comments).


If I misunderstand about it, please let me know where I can find the C
files.




Best regards,

Taekho Nam



_______________________________________________
iovisor-dev mailing list
iovisor-dev@...
https://lists.iovisor.org/mailman/listinfo/iovisor-dev


thnam
 

Thank you so much Affan.

I did it. I forked iovisor bcc repository and made new branch.
And also edit a CONTRIBUTING-SCRIPTS.md files. Finally I put in a pull request on github!

I have never been experienced this contribution process, It's really interesting!

I expect that it will be my first contribution in opensource projects.

Best regards,
Taekho Nam.

On Mon, Sep 26, 2016 at 1:43 PM, Affan Ahmed Syed <asyed@...> wrote:
Taekho,

good catch. You should go ahead edit a copy of the README.md with an
example that has both python and c files and put in a pull request (on
github). That should make you a contributor.

Affan

On Sun, Sep 25, 2016 at 8:28 PM, Taekho Nam via iovisor-dev
<iovisor-dev@...> wrote:
> Hello All,
>
> I am a student majored in Computer Science from Korea.
>
> I want to be contributor in IO Visor project, so I'm reading all docs and
> source code in IO Visor webpage & Github.
> While I read 'Contributing bcc/eBPF scripts' in
> github(https://github.com/iovisor/bcc/blob/master/CONTRIBUTING-SCRIPTS.md),
> I discovered something to need to be update.
>
> This documents said that tracing/strlen_count.py is a Python program with
> embedded C, and tracing/bitehist.* are separate Python and C files.
> But I can't find the bitehist.c file. I think that the source file that
> named by bitehist.py is also a Python program with embedded C such as
> strlen_count.py.
>
> Examples
>
> These are grouped into subdirectories (networking, tracing). Your example
> can either be a Python program with embedded C (eg,
> tracing/strlen_count.py), or separate Python and C files (eg,
> tracing/bitehist.*).
>
> As said earlier: keep it short, neat, and documented (code comments).
>
>
> If I misunderstand about it, please let me know where I can find the C
> files.
>
>
>
>
> Best regards,
>
> Taekho Nam
>
>
>
> _______________________________________________
> iovisor-dev mailing list
> iovisor-dev@...
> https://lists.iovisor.org/mailman/listinfo/iovisor-dev
>