mostly taken from ryu.wiki/API.md and conveted by hand.
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
- add explicit classified layout to ofproto_v1_[23]_ref
- put contents of ofproto_ref back to toctree.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
ryu/lib/packet/icmpv6.py:docstring of ryu.lib.packet.icmpv6.nd_option_pi:23: WARNING: Inline emphasis start-string without end-string.
ryu/doc/source/ofproto_v1_2_ref.rst:: WARNING: document isn't included in any toctree
ryu/doc/source/ofproto_v1_3_ref.rst:: WARNING: document isn't included in any toctree
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
ofproto_v1_3_parser.OFPMatch:
add a list of available fields.
ofproto_v1_2_parser.OFPMatch:
add docstrings same as of1.3.
doc:
add reference page for of1.2
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
ryu-client isn't installed any more as it has been moved to ryu/tests.
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Remove OpenStack related documents except using_with_openstack.
README of Quantum Ryu plugin refers to it.
remove:
doc/source/images/*
doc/source/openstack.rst
doc/source/step_by_step.rst
doc/source/internals_l2_isolation.rst
modified:
doc/source/index.rst
remove index of openstack.rst.
doc/source/using_with_openstack.rst
replace contents with the pointer to the wiki page.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
We need to use absolute file names when running set-ssl command.
Signed-off-by: OHMURA Kei <ohmura.kei@lab.ntt.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
s/_/-/ in option names.
note: some parts of them (eg. eventdumper, nova, ...) looks outdated
but i didn't try to update them at least in this commit.
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
try to sync the documentation with the reality at least about
gflags/cfg changes.
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
In order to quieten rpmlint
> ryu.noarch: W: no-manual-page-for-binary ryu-manager
> Each executable in standard binary directories should have a man page.
>
> ryu.noarch: W: no-manual-page-for-binary ryu-client
> Each executable in standard binary directories should have a man page.
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This patch eliminates the following sphinx warnings.
> ryu/doc/source/parameters.rst:47: ERROR: Unexpected indentation.
> ryu/doc/source/step_by_step.rst:1: WARNING: malformed hyperlink target.
> ryu/doc/source/step_by_step.rst:164: ERROR: Inconsistent literal block quoting.
> ryu/doc/source/step_by_step.rst:229: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:278: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:320: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:329: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:333: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:357: WARNING: Bullet list ends without a blank line; unexpected unindent.
> checking consistency... ryudoc/source/parameters.rst:: WARNING: document isn't included in any toctree
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Rearrange the top page in the following way:
- Getting Started
- Cloud Integration (OpenStack only for now)
- Developing Your App
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
The 'getting_started' content overlaps with README. It also includes
more advanced information than 'getting_started'. This is preparation
for making README 'getting_started'.
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
