1
0
mirror of https://github.com/CumulusNetworks/ifupdown2.git synced 2024-05-06 15:54:50 +00:00
Roopa Prabhu ff50f301d5 move ifupdown2/* .
ifupdown2 code was one level deeper because ifupdown2 initially
had ifupdown2 and ifupdown2-addons as two separate packages.
Since they were combined into one package, it makes sense to
move all combined code under the top level directory

Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2015-08-02 05:05:52 -07:00

66 lines
1.2 KiB
ReStructuredText

Documentation for the Code
**************************
ifupdownmain
============
ifupdownmain is the main ifupdown module.
.. automodule:: ifupdownmain
.. autoclass:: ifupdownMain
:members: up, down, reload, query
iface
=====
.. automodule:: iface
.. autoclass:: iface
:members: state, status, flags, priv_flags, refcnt, lowerifaces, upperifaces, add_to_upperifaces, get_attr_value, get_attr_value_first, get_attr_value_n, update_config, update_config_with_status, get_config_attr_status, compare, dump_raw, dump, dump_pretty
.. autoclass:: ifaceState
.. autoclass:: ifaceStatus
.. autoclass:: ifaceJsonEncoder
scheduler
=========
.. automodule:: scheduler
.. autoclass:: ifaceScheduler
:members: sched_ifaces
.. autoclass:: ifaceSchedulerFlags
networkinterfaces
=================
.. automodule:: networkinterfaces
.. autoclass:: networkInterfaces
:members: load, subscribe
statemanager
============
.. automodule:: statemanager
.. autoclass:: pickling
:members: save, save_obj, load
.. autoclass:: stateManager
:members: read_saved_state, save_state
graph
=====
.. automodule:: graph
.. autoclass:: graph
:members: topological_sort_graphs_all, generate_dots