summaryrefslogtreecommitdiffhomepage
path: root/doc/source
AgeCommit message (Collapse)Author
2013-09-02doc: fix warningsFUJITA Tomonori
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-02doc: update reference page for ofproto.Yoshihiro Kaneko
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-24fix the commit 833328a mess-upFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-23doc: fix overflow from the page in latex/pdf.Yoshihiro Kaneko
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-23of1.2, of1.3: update document for OFPMatchYoshihiro Kaneko
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-13doc: add reference for ofproto api documentYoshihiro Kaneko
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13doc: fix some sphinx warnings and errorsYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13doc: fix a typoYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-12lib/packet: add Internet Group Management ProtocolYuichi Ito
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01note about network address representationYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01packet lib api: update documentationYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01add 2013 to copyright for documentationsFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-31update library_packet_ref.rstwatanabe.fumitaka
Signed-off-by: WATANABE Fumitaka <watanabe.fumitaka@nttcom.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-24lib/packet: add Link Aggregation Control ProtocolYuichi Ito
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-09man: remove man page of ryu clientIsaku Yamahata
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-05-31Add 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-23docs: fix ryu module importFUJITA Tomonori
readthedocs.org complains about the failure about ryu module import. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-24add a template for ryu.lib.packet class documentation.YAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-16g/c a stale reference to find_protocolYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-04-02remove openstack related documentYoshihiro Kaneko
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-01doc: fix a program nameYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-18TLS: use a full spelling of a cli optionYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-18TLS: update an example outputYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-08doc: of_config libraryIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-03-06doc: fix bug in tls.rstOHMURA Kei
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-02-25try to sync documentation with the realityYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-25mechanical documentation update after option name changesYAMAMOTO Takashi
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-15doc: internal document on openstack cooperationIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-14update a sample and documentationYAMAMOTO Takashi
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-12doc: man pages for ryu-manager and ryu-clientIsaku Yamahata
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-12doc: eliminate sphinx warningsIsaku Yamahata
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>
2012-12-11doc: setup TLS connectionOHMURA Kei
Signed-off-by: OHMURA Kei <ohmura.kei@lab.ntt.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-10-06doc: update packet libraryFUJITA Tomonori
Use Packet class iterator feature Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17doc: fix typo in openstack.rstFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17doc: rearrange top pageFUJITA Tomonori
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-17doc: use README as getting_startedFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17doc: rename getting_started.rst -> parameters.rstFUJITA Tomonori
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-14doc: rearrange openstack docsFUJITA Tomonori
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-14doc: packet libraryFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-03doc: write Ryu applicationFUJITA Tomonori
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-02doc: use ryu version constantFUJITA Tomonori
- 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-02doc: change Sphinx style to haikuFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-05-07doc/source/step_by_step.rst: add item to setup quantum dbIsaku Yamahata
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-04-06update docs on the license switchFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-22doc: update using_with_openstack.rst to catch up openstackIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-17doc: update osrg/nova, quantum repositoryIsaku Yamahata
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-14doc: sample configuration filesIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-14doc: step-by-step exampleIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-02-01doc: how to invoke ryu-manager, its options and exampleIsaku Yamahata
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-01-04doc: how-l2-segregation-works: update images a bitIsaku Yamahata
Use arrows consistently. Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-09 07:28:31 +0000