From 801f32ef7894c93d7e69b91722e554590031259c Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Wed, 15 Aug 2012 12:21:31 +0200 Subject: [PATCH] doc: Restructure - split it to multiple chapters --- doc/Makefile | 10 +++++----- doc/orte/orte_api.xml | 4 ++-- doc/orte/orte_examples.xml | 4 ++-- doc/orte/orte_internals.xml | 6 +++--- doc/orte/orte_intro.xml | 18 +++++++++++++----- doc/orte/orte_tests.xml | 5 ++--- doc/orte/orte_usage.xml | 4 ++-- doc/orte_incl.ent | 3 --- doc/ortedoc.xml | 34 ---------------------------------- doc/orteman.xml | 17 +++++++++++++++-- 10 files changed, 44 insertions(+), 61 deletions(-) delete mode 100644 doc/ortedoc.xml diff --git a/doc/Makefile b/doc/Makefile index 362aeff..f4e9ca6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -36,11 +36,11 @@ XML_ENTITIES = $(shell cat $(XML_ENT_INCS) | \ clean: - @rm -f ${XML_BASENAMES:%=%.html} - @rm -f ${XML_BASENAMES:%=%.pdf} - @rm -f ./*.log - @rm -f ./*.out - @rm -f ./*~ + rm -f ${XML_BASENAMES:%=%.html} + rm -f ${XML_BASENAMES:%=%.pdf} $(FIGS:%.fig=%.pdf) $(ORTE_DOC_SOURCES) + rm -f ./*.log + rm -f ./*.out + rm -f ./*~ %.pdf: %.fig fig2dev -L pdf $^ $@ diff --git a/doc/orte/orte_api.xml b/doc/orte/orte_api.xml index e601347..d4955de 100644 --- a/doc/orte/orte_api.xml +++ b/doc/orte/orte_api.xml @@ -1,5 +1,5 @@ -
+ ORTE API
@@ -17,4 +17,4 @@ &orte_defines_api;
-
+ diff --git a/doc/orte/orte_examples.xml b/doc/orte/orte_examples.xml index 4096877..9564adc 100644 --- a/doc/orte/orte_examples.xml +++ b/doc/orte/orte_examples.xml @@ -1,5 +1,5 @@ -
+ ORTE Examples @@ -312,4 +312,4 @@ BoxTypeDeserialize(CDR_Codec *cdrCodec, void *instance) {
- + diff --git a/doc/orte/orte_internals.xml b/doc/orte/orte_internals.xml index 1605adc..6eb4dd0 100644 --- a/doc/orte/orte_internals.xml +++ b/doc/orte/orte_internals.xml @@ -1,6 +1,6 @@ -
- ORTE Implementation Issues + + ORTE Internals ORTE is network middleware for distributed, real-time application development @@ -247,4 +247,4 @@ -
+ diff --git a/doc/orte/orte_intro.xml b/doc/orte/orte_intro.xml index 22d3d97..cacf673 100644 --- a/doc/orte/orte_intro.xml +++ b/doc/orte/orte_intro.xml @@ -2,10 +2,18 @@
Introduction + The Open Real-Time Ethernet (ORTE) is open source implementation of + RTPS communication protocol. RTPS is new application layer protocol + targeted to real-time communication area, which is build on the top of + standard UDP stack. Since there are many TCP/IP stack implementations + under many operating systems and RTPS protocol does not have any other + special HW/SW requirements, it should be easily ported to many HW/SW + target platforms. Because it uses only UDP protocol, it retains control of + timing and reliability. + + - The Open Real-Time Ethernet (ORTE) is - open source implementation of RTPS communication protocol. This protocol - is being to submit to IETF as an informational RFC and has been adopted - by the IDA group. + RTPS protocol is being to submit to IETF as an informational RFC + and has been adopted by the IDA group. -
\ No newline at end of file + diff --git a/doc/orte/orte_tests.xml b/doc/orte/orte_tests.xml index 0110ff9..e5706d4 100644 --- a/doc/orte/orte_tests.xml +++ b/doc/orte/orte_tests.xml @@ -1,5 +1,5 @@ -
+ ORTE Tests @@ -8,5 +8,4 @@ protocol. Results of these test indicate that ORTE is fully interoperable with implementation provided by another vendor. -
- + diff --git a/doc/orte/orte_usage.xml b/doc/orte/orte_usage.xml index 4498e06..b36b66f 100644 --- a/doc/orte/orte_usage.xml +++ b/doc/orte/orte_usage.xml @@ -1,5 +1,5 @@ -
+ ORTE Usage Information
@@ -300,4 +300,4 @@ manager 0xc0a80001-0x123402 was deleted &orte_ortespy;
-
+ diff --git a/doc/orte_incl.ent b/doc/orte_incl.ent index 7f54e6e..c97943a 100644 --- a/doc/orte_incl.ent +++ b/doc/orte_incl.ent @@ -1,4 +1,3 @@ - @@ -29,5 +28,3 @@ - - diff --git a/doc/ortedoc.xml b/doc/ortedoc.xml deleted file mode 100644 index 1d33620..0000000 --- a/doc/ortedoc.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - Open Real-Time Ethernet - - The Open Real-Time Ethernet (ORTE) is open source implementation of - RTPS communication protocol. RTPS is new application layer protocol - targeted to real-time communication area, which is build on the top of - standard UDP stack. Since there are many TCP/IP stack implementations - under many operating systems and RTPS protocol does not have any other - special HW/SW requirements, it should be easily ported to many HW/SW - target platforms. Because it uses only UDP protocol, it retains control of - timing and reliability. - -
- ORTE Summary - - &orte_summary; -
- -
- ORTE Description - - &orte_intro; - &orte_ps_model; - &orte_rtps_model; -
- - &orte_internals; - &orte_examples; - &orte_tests; - &orte_usage; - &orte_api; - - diff --git a/doc/orteman.xml b/doc/orteman.xml index 096195d..ec1b7c9 100644 --- a/doc/orteman.xml +++ b/doc/orteman.xml @@ -81,7 +81,7 @@ --> - ORTE - Open Real-Time Ethernet + ORTE – Open Real-Time Ethernet -&orte; + + ORTE Description + + &orte_intro; + &orte_ps_model; + &orte_rtps_model; + + + &orte_internals; + &orte_examples; + &orte_tests; + &orte_usage; + &orte_api; + -- 2.39.2