[ovs-dev] [PATCH] python: add IDL examples

Ben Pfaff blp at ovn.org
Tue Jun 19 19:58:36 UTC 2018


On Tue, Jun 19, 2018 at 11:51:00AM -0700, Cpp Code wrote:
> Do we need licensing information in these sample files?
> 
> On Mon, Jun 18, 2018 at 8:53 PM, Ben Pfaff <blp at ovn.org> wrote:
> 
> > On Sun, Jun 17, 2018 at 04:24:34AM -0700, Toms Atteka wrote:
> > > created sample python scripts, which helps to learn how to use OVSDB
> > library
> > >
> > > Signed-off-by: Toms Atteka <cpp.code at gmail.com>
> >
> > Thanks for working on making it easier to understand how to use Open
> > vSwitch.
> >
> > This doesn't build, because:
> >
> >     The following files are in git but not the distribution:
> >     python/howto/IDL/delete_bridges.py
> >     python/howto/IDL/insert_bridge.py
> >     python/howto/IDL/ovs_monitor.py
> >     Makefile:6214: recipe for target 'dist-hook-git' failed
> >
> > I think it would be good to ensure that flake8 runs on the new files
> > too.
> >
> > Do you have an idea how these new files can be discoverable to users?
> 
> 
> So far I am not really sure which would be the best way to do that.
> 
> 
> > I guess you decided that they should not be in the Documentation
> > directory.
> 
> 
> From current structure documentation folder feels more like textual
> information.
> 
> 
> > Maybe there should at least be a pointer to them from the
> > documentation.
> 
> 
> I could add reference inside integration.rst below: "More information on
> the python bindings is available at ``python/ovs/db/idl.py``."

That could be helpful.

Maybe it would be worth writing a brief document about the Python IDL
for the Documentation directory?  It could point to the examples and
explain a little bit about them.


More information about the dev mailing list