Commit Graph

54 Commits

Author SHA1 Message Date
FUJITA Tomonori
eacabd75c5 doc: fix warnings
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>
2013-09-02 20:12:51 +09:00
Yoshihiro Kaneko
673c811f85 doc: update reference page for ofproto.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-02 19:43:50 +09:00
FUJITA Tomonori
45a34eb9df fix the commit 833328a mess-up
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-24 08:05:06 +09:00
Yoshihiro Kaneko
f8da5a9c79 doc: fix overflow from the page in latex/pdf.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-23 20:20:08 +09:00
Yoshihiro Kaneko
833328a54e of1.2, of1.3: update document for OFPMatch
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>
2013-08-23 20:16:58 +09:00
Yoshihiro Kaneko
d0b4e50d29 doc: add reference for ofproto api document
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 20:26:01 +09:00
YAMAMOTO Takashi
0a8e581628 doc: fix some sphinx warnings and errors
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:54 +09:00
YAMAMOTO Takashi
beb9867d7a doc: fix a typo
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:51 +09:00
Yuichi Ito
d84d9a7c93 lib/packet: add Internet Group Management Protocol
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-12 09:37:56 +09:00
YAMAMOTO Takashi
37a11525df note about network address representation
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 14:26:00 +09:00
YAMAMOTO Takashi
d29b3b3d7a packet lib api: update documentation
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 14:25:51 +09:00
FUJITA Tomonori
a1f5d458df add 2013 to copyright for documentations
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 08:12:00 +09:00
watanabe.fumitaka
ad3b896d58 update library_packet_ref.rst
Signed-off-by: WATANABE Fumitaka <watanabe.fumitaka@nttcom.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-31 19:43:30 +09:00
Yuichi Ito
a1b6d39f9d lib/packet: add Link Aggregation Control Protocol
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-24 02:58:36 +09:00
Isaku Yamahata
9dcdf938b4 man: remove man page of ryu client
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>
2013-07-09 12:12:30 +09:00
竹下昇
f9b24a1720 Add Packet library API Reference
Add DHCP encoder/decoder class.

Signed-off-by: TAKESHITA Noboru <takeshita.noboru@yes.nttcom.ne.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-05-31 17:54:01 +09:00
FUJITA Tomonori
f09407e4d6 docs: fix ryu module import
readthedocs.org complains about the failure about ryu module import.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-05-23 07:46:59 +09:00
YAMAMOTO Takashi
3488d0b820 add a template for ryu.lib.packet class documentation.
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-24 19:39:39 +09:00
YAMAMOTO Takashi
db46baf4e8 g/c a stale reference to find_protocol
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-16 02:55:09 +09:00
Yoshihiro Kaneko
9c1bc8ba2f remove openstack related document
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>
2013-04-02 19:34:37 +09:00
YAMAMOTO Takashi
a744128ef1 doc: fix a program name
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-01 21:16:53 +09:00
YAMAMOTO Takashi
9126ac201f TLS: use a full spelling of a cli option
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-18 22:26:36 +09:00
YAMAMOTO Takashi
fc584ae3d8 TLS: update an example output
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-18 22:26:32 +09:00
Isaku Yamahata
914826d474 doc: of_config library
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-08 12:12:03 +09:00
OHMURA Kei
be014d73ea doc: fix bug in tls.rst
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>
2013-03-06 07:18:11 +09:00
YAMAMOTO Takashi
e1c7f737f5 try to sync documentation with the reality
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-25 20:08:44 +09:00
YAMAMOTO Takashi
0a6d7c5619 mechanical documentation update after option name changes
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>
2013-02-25 20:08:22 +09:00
Isaku Yamahata
be07508b43 doc: internal document on openstack cooperation
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-15 17:06:41 +09:00
YAMAMOTO Takashi
9ba977fa41 update a sample and documentation
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>
2013-02-14 12:34:08 +09:00
Isaku Yamahata
5d9efe045e doc: man pages for ryu-manager and ryu-client
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>
2013-02-12 20:21:31 +09:00
Isaku Yamahata
48bd30f8f1 doc: eliminate sphinx warnings
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>
2013-02-12 20:21:26 +09:00
OHMURA Kei
70194beabe doc: setup TLS connection
Signed-off-by: OHMURA Kei <ohmura.kei@lab.ntt.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-12-11 22:52:23 -08:00
FUJITA Tomonori
ef8284dfd1 doc: update packet library
Use Packet class iterator feature

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-10-06 13:16:18 +09:00
FUJITA Tomonori
3cd6423a3f doc: fix typo in openstack.rst
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17 13:15:48 +09:00
FUJITA Tomonori
83e53c5065 doc: rearrange top page
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>
2012-09-17 13:15:47 +09:00
FUJITA Tomonori
e1e85442ff doc: use README as getting_started
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17 13:15:45 +09:00
FUJITA Tomonori
9b3246a630 doc: rename getting_started.rst -> parameters.rst
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>
2012-09-17 13:15:44 +09:00
FUJITA Tomonori
8b7950dc36 doc: rearrange openstack docs
The following docs are about OpenStack:

using_with_openstack.rst
step_by_step.rst
how_l2_segregation_work.rst

So let's create 'OpenStack' section in the index and put three under
the section.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-14 16:31:25 +09:00
FUJITA Tomonori
5e8d29832d doc: packet library
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-14 16:30:43 +09:00
FUJITA Tomonori
7e95ccb8e7 doc: write Ryu application
This is the first doc for someone who wants to write his Ryu
applicaiton.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-03 13:39:16 +09:00
FUJITA Tomonori
6cc438cb0e doc: use ryu version constant
- Use ryu version constant instead of setting the version by hand.
- update Copyright

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-02 09:29:50 +09:00
FUJITA Tomonori
ab1253e441 doc: change Sphinx style to haiku
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-02 09:29:47 +09:00
Isaku Yamahata
3cf1b23b0e doc/source/step_by_step.rst: add item to setup quantum db
The step to create quantum db was missing.

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-05-07 15:57:25 +09:00
FUJITA Tomonori
96c91e59d6 update docs on the license switch
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-04-06 10:33:53 +09:00
Isaku Yamahata
de3308d10c doc: update using_with_openstack.rst to catch up openstack
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-22 20:26:48 +09:00
Isaku Yamahata
c7d42280cf doc: update osrg/nova, quantum repository
Updated the documentation to refer the repository as I updated the repos,
github.com/osrg/nova.git and github.com/osrg/quantum.git

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-17 11:35:12 +09:00
Isaku Yamahata
74858adb16 doc: sample configuration files
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-14 06:28:57 +09:00
Isaku Yamahata
a110a9c956 doc: step-by-step example
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-14 06:28:54 +09:00
Isaku Yamahata
6ff0a21ce7 doc: how to invoke ryu-manager, its options and example
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-01 08:55:51 +09:00
Isaku Yamahata
3f7d742881 doc: how-l2-segregation-works: update images a bit
Use arrows consistently.

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-01-04 16:17:20 +09:00