openstack/deb-ryu
Code Issues Proposed changes

library_packet_ref: Separate ref into each protocol

Browse Source 
To keep readablity if include all class into library reference, this
patch separates library_packet_ref.rst into each protocol.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
Shinpei Muraoka 2017-04-07 15:19:21 +09:00 committed by FUJITA Tomonori
parent 99e7cc4074
commit 077eef801e
32 changed files with 193 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
doc/source/library_packet_ref.rst
View File

@ -14,175 +14,15 @@ Stream Parser class
.. automodule:: ryu.lib.packet.stream_parser
:members:
.. autoclass:: ryu.lib.packet.bgp.StreamParser
:members:
List of the sub-classes:
- :py:mod:`ryu.lib.packet.bgp.StreamParser`
Protocol Header classes
=======================
.. automodule:: ryu.lib.packet.packet_base
:members:
.. toctree::
:glob:
.. automodule:: ryu.lib.packet.ethernet
:members:
.. autoclass:: ryu.lib.packet.lldp.lldp
:members:
.. automodule:: ryu.lib.packet.vlan
:members:
.. automodule:: ryu.lib.packet.pbb
:members:
.. automodule:: ryu.lib.packet.mpls
:members:
.. automodule:: ryu.lib.packet.arp
:members:
.. automodule:: ryu.lib.packet.ipv4
:members:
.. automodule:: ryu.lib.packet.icmp
:members:
.. automodule:: ryu.lib.packet.ipv6
:members:
.. automodule:: ryu.lib.packet.icmpv6
:members:
.. automodule:: ryu.lib.packet.vxlan
:members:
.. automodule:: ryu.lib.packet.geneve
:members:
.. automodule:: ryu.lib.packet.gre
:members:
.. automodule:: ryu.lib.packet.cfm
:members:
.. automodule:: ryu.lib.packet.tcp
:members:
.. automodule:: ryu.lib.packet.udp
:members:
.. automodule:: ryu.lib.packet.dhcp
:members:
.. autoclass:: ryu.lib.packet.dhcp6.dhcp6
:members:
.. autoclass:: ryu.lib.packet.dhcp6.options
:members:
.. autoclass:: ryu.lib.packet.dhcp6.option
:members:
.. autoclass:: ryu.lib.packet.vrrp.vrrp
:members:
.. autoclass:: ryu.lib.packet.vrrp.vrrpv2
:members:
.. autoclass:: ryu.lib.packet.vrrp.vrrpv3
:members:
.. autoclass:: ryu.lib.packet.slow.slow
:members:
.. autoclass:: ryu.lib.packet.slow.lacp
:members:
.. autoclass:: ryu.lib.packet.llc.llc
:members:
.. autoclass:: ryu.lib.packet.llc.ControlFormatI
:members:
.. autoclass:: ryu.lib.packet.llc.ControlFormatS
:members:
.. autoclass:: ryu.lib.packet.llc.ControlFormatU
:members:
.. autoclass:: ryu.lib.packet.bpdu.bpdu
:members:
.. autoclass:: ryu.lib.packet.bpdu.ConfigurationBPDUs
:members:
.. autoclass:: ryu.lib.packet.bpdu.TopologyChangeNotificationBPDUs
:members:
.. autoclass:: ryu.lib.packet.bpdu.RstBPDUs
:members:
.. autoclass:: ryu.lib.packet.igmp.igmp
:members:
.. autoclass:: ryu.lib.packet.igmp.igmpv3_query
:members:
.. autoclass:: ryu.lib.packet.igmp.igmpv3_report
:members:
.. autoclass:: ryu.lib.packet.igmp.igmpv3_report_group
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPMessage
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPOpen
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPUpdate
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPKeepAlive
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPNotification
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnArbitraryEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnLACPEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnL2BridgeEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnMacBasedEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnRouterIDEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.EvpnASBasedEsi
:members:
.. autoclass:: ryu.lib.packet.bgp.FlowSpecIPv4NLRI
:members:
.. autoclass:: ryu.lib.packet.bgp.FlowSpecVPNv4NLRI
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficRateCommunity
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficActionCommunity
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecRedirectCommunity
:members:
.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficMarkingCommunity
:members:
.. automodule:: ryu.lib.packet.bmp
:members:
.. autoclass:: ryu.lib.packet.bfd.bfd
:members:
.. autoclass:: ryu.lib.packet.bfd.SimplePassword
:members:
.. autoclass:: ryu.lib.packet.bfd.KeyedMD5
:members:
.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedMD5
:members:
.. autoclass:: ryu.lib.packet.bfd.KeyedSHA1
:members:
.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedSHA1
:members:
.. automodule:: ryu.lib.packet.openflow
:members:
.. autoclass:: ryu.lib.packet.ospf.OSPFMessage
:members:
.. automodule:: ryu.lib.packet.sctp
:members:
.. autoclass:: ryu.lib.packet.zebra.ZebraMessage
library_packet_ref/packet_base
library_packet_ref/*

6
doc/source/library_packet_ref/packet_arp.rst Normal file
View File

@ -0,0 +1,6 @@
***
ARP
***
.. automodule:: ryu.lib.packet.arp
:members:

6
doc/source/library_packet_ref/packet_base.rst Normal file
View File

@ -0,0 +1,6 @@
*****************
Packet Base Class
*****************
.. automodule:: ryu.lib.packet.packet_base
:members:

6
doc/source/library_packet_ref/packet_bfd.rst Normal file
View File

@ -0,0 +1,6 @@
***
BFD
***
.. automodule:: ryu.lib.packet.bfd
:members:

6
doc/source/library_packet_ref/packet_bgp.rst Normal file
View File

@ -0,0 +1,6 @@
***
BGP
***
.. automodule:: ryu.lib.packet.bgp
:members:

6
doc/source/library_packet_ref/packet_bmp.rst Normal file
View File

@ -0,0 +1,6 @@
***
BMP
***
.. automodule:: ryu.lib.packet.bmp
:members:

6
doc/source/library_packet_ref/packet_bpdu.rst Normal file
View File

@ -0,0 +1,6 @@
****
BPDU
****
.. automodule:: ryu.lib.packet.bpdu
:members:

6
doc/source/library_packet_ref/packet_cfm.rst Normal file
View File

@ -0,0 +1,6 @@
***
CFM
***
.. automodule:: ryu.lib.packet.cfm
:members:

6
doc/source/library_packet_ref/packet_dhcp.rst Normal file
View File

@ -0,0 +1,6 @@
****
DHCP
****
.. automodule:: ryu.lib.packet.dhcp
:members:

6
doc/source/library_packet_ref/packet_dhcp6.rst Normal file
View File

@ -0,0 +1,6 @@
*****
DHCP6
*****
.. automodule:: ryu.lib.packet.dhcp6
:members:

6
doc/source/library_packet_ref/packet_ethernet.rst Normal file
View File

@ -0,0 +1,6 @@
********
Ehternet
********
.. automodule:: ryu.lib.packet.ethernet
:members:

6
doc/source/library_packet_ref/packet_geneve.rst Normal file
View File

@ -0,0 +1,6 @@
******
Geneve
******
.. automodule:: ryu.lib.packet.geneve
:members:

6
doc/source/library_packet_ref/packet_gre.rst Normal file
View File

@ -0,0 +1,6 @@
***
GRE
***
.. automodule:: ryu.lib.packet.gre
:members:

6
doc/source/library_packet_ref/packet_icmp.rst Normal file
View File

@ -0,0 +1,6 @@
****
ICMP
****
.. automodule:: ryu.lib.packet.icmp
:members:

6
doc/source/library_packet_ref/packet_icmpv6.rst Normal file
View File

@ -0,0 +1,6 @@
******
ICMPv6
******
.. automodule:: ryu.lib.packet.icmpv6
:members:

6
doc/source/library_packet_ref/packet_igmp.rst Normal file
View File

@ -0,0 +1,6 @@
****
IGMP
****
.. automodule:: ryu.lib.packet.igmp
:members:

6
doc/source/library_packet_ref/packet_ipv4.rst Normal file
View File

@ -0,0 +1,6 @@
****
IPv4
****
.. automodule:: ryu.lib.packet.ipv4
:members:

6
doc/source/library_packet_ref/packet_ipv6.rst Normal file
View File

@ -0,0 +1,6 @@
****
IPv6
****
.. automodule:: ryu.lib.packet.ipv6
:members:

6
doc/source/library_packet_ref/packet_llc.rst Normal file
View File

@ -0,0 +1,6 @@
***
LLC
***
.. automodule:: ryu.lib.packet.llc
:members:

6
doc/source/library_packet_ref/packet_lldp.rst Normal file
View File

@ -0,0 +1,6 @@
****
LLDP
****
.. automodule:: ryu.lib.packet.lldp
:members:

6
doc/source/library_packet_ref/packet_mpls.rst Normal file
View File

@ -0,0 +1,6 @@
****
MPLS
****
.. automodule:: ryu.lib.packet.mpls
:members:

6
doc/source/library_packet_ref/packet_openflow.rst Normal file
View File

@ -0,0 +1,6 @@
********
OpenFlow
********
.. automodule:: ryu.lib.packet.openflow
:members:

6
doc/source/library_packet_ref/packet_ospf.rst Normal file
View File

@ -0,0 +1,6 @@
****
OSPF
****
.. automodule:: ryu.lib.packet.ospf
:members:

6
doc/source/library_packet_ref/packet_pbb.rst Normal file
View File

@ -0,0 +1,6 @@
***
PBB
***
.. automodule:: ryu.lib.packet.pbb
:members:

6
doc/source/library_packet_ref/packet_sctp.rst Normal file
View File

@ -0,0 +1,6 @@
****
SCTP
****
.. automodule:: ryu.lib.packet.sctp
:members:

6
doc/source/library_packet_ref/packet_slow.rst Normal file
View File

@ -0,0 +1,6 @@
****
Slow
****
.. automodule:: ryu.lib.packet.slow
:members:

6
doc/source/library_packet_ref/packet_tcp.rst Normal file
View File

@ -0,0 +1,6 @@
***
TCP
***
.. automodule:: ryu.lib.packet.tcp
:members:

6
doc/source/library_packet_ref/packet_udp.rst Normal file
View File

@ -0,0 +1,6 @@
***
UDP
***
.. automodule:: ryu.lib.packet.udp
:members:

6
doc/source/library_packet_ref/packet_vlan.rst Normal file
View File

@ -0,0 +1,6 @@
****
VLAN
****
.. automodule:: ryu.lib.packet.vlan
:members:

6
doc/source/library_packet_ref/packet_vrrp.rst Normal file
View File

@ -0,0 +1,6 @@
****
VRRP
****
.. automodule:: ryu.lib.packet.vrrp
:members:

6
doc/source/library_packet_ref/packet_vxlan.rst Normal file
View File

@ -0,0 +1,6 @@
*****
VXLAN
*****
.. automodule:: ryu.lib.packet.vxlan
:members:

6
doc/source/library_packet_ref/packet_zebra.rst Normal file
View File

@ -0,0 +1,6 @@
*****
Zebra
*****
.. automodule:: ryu.lib.packet.zebra
:members: