[PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-09 Thread Vijay Kumar Banerjee
---
 book/index_book.rst   | 2 +-
 {networking => legacy-networking}/command.rst | 0
 {networking => legacy-networking}/conf.py | 4 ++--
 {networking => legacy-networking}/dec_21140.rst   | 0
 {networking => legacy-networking}/index.rst   | 2 +-
 {networking => legacy-networking}/network_servers.rst | 0
 {networking => legacy-networking}/network_task_structure.rst  | 0
 {networking => legacy-networking}/networking_driver.rst   | 0
 {networking => legacy-networking}/preface.rst | 0
 {networking => legacy-networking}/testing_the_driver.rst  | 0
 .../using_networking_rtems_app.rst| 0
 {networking => legacy-networking}/wscript | 0
 wscript   | 2 +-
 13 files changed, 5 insertions(+), 5 deletions(-)
 rename {networking => legacy-networking}/command.rst (100%)
 rename {networking => legacy-networking}/conf.py (68%)
 rename {networking => legacy-networking}/dec_21140.rst (100%)
 rename {networking => legacy-networking}/index.rst (92%)
 rename {networking => legacy-networking}/network_servers.rst (100%)
 rename {networking => legacy-networking}/network_task_structure.rst (100%)
 rename {networking => legacy-networking}/networking_driver.rst (100%)
 rename {networking => legacy-networking}/preface.rst (100%)
 rename {networking => legacy-networking}/testing_the_driver.rst (100%)
 rename {networking => legacy-networking}/using_networking_rtems_app.rst (100%)
 rename {networking => legacy-networking}/wscript (100%)

diff --git a/book/index_book.rst b/book/index_book.rst
index 8282006..3fc67d2 100644
--- a/book/index_book.rst
+++ b/book/index_book.rst
@@ -23,7 +23,7 @@ Table of Contents
cpu_supplement/index.rst
develenv/index.rst
filesystem/index.rst
-   networking/index.rst
+   legacy_networking/index.rst
porting/index.rst
posix1003_1/index.rst
posix_users/index.rst
diff --git a/networking/command.rst b/legacy-networking/command.rst
similarity index 100%
rename from networking/command.rst
rename to legacy-networking/command.rst
diff --git a/networking/conf.py b/legacy-networking/conf.py
similarity index 68%
rename from networking/conf.py
rename to legacy-networking/conf.py
index 1c129bc..6cc01bc 100644
--- a/networking/conf.py
+++ b/legacy-networking/conf.py
@@ -3,12 +3,12 @@ sys.path.insert(0, os.path.abspath('../common/'))
 
 from conf import *
 
-project = "RTEMS Networking User Manual"
+project = "RTEMS Legacy Networking User Manual"
 
 latex_documents = [
 ('index',
  'networking.tex',
- u'RTEMS Networking User Manual',
+ u'RTEMS Legacy Networking User Manual',
  u'RTEMS Documentation Project',
  'manual'),
 ]
diff --git a/networking/dec_21140.rst b/legacy-networking/dec_21140.rst
similarity index 100%
rename from networking/dec_21140.rst
rename to legacy-networking/dec_21140.rst
diff --git a/networking/index.rst b/legacy-networking/index.rst
similarity index 92%
rename from networking/index.rst
rename to legacy-networking/index.rst
index f56a60d..b85119d 100644
--- a/networking/index.rst
+++ b/legacy-networking/index.rst
@@ -5,7 +5,7 @@
 .. highlight:: c
 
 ==
-RTEMS Network User Manual (|version|).
+RTEMS Legacy Network User Manual (|version|).
 ==
 
 .. topic:: Copyrights and License
diff --git a/networking/network_servers.rst 
b/legacy-networking/network_servers.rst
similarity index 100%
rename from networking/network_servers.rst
rename to legacy-networking/network_servers.rst
diff --git a/networking/network_task_structure.rst 
b/legacy-networking/network_task_structure.rst
similarity index 100%
rename from networking/network_task_structure.rst
rename to legacy-networking/network_task_structure.rst
diff --git a/networking/networking_driver.rst 
b/legacy-networking/networking_driver.rst
similarity index 100%
rename from networking/networking_driver.rst
rename to legacy-networking/networking_driver.rst
diff --git a/networking/preface.rst b/legacy-networking/preface.rst
similarity index 100%
rename from networking/preface.rst
rename to legacy-networking/preface.rst
diff --git a/networking/testing_the_driver.rst 
b/legacy-networking/testing_the_driver.rst
similarity index 100%
rename from networking/testing_the_driver.rst
rename to legacy-networking/testing_the_driver.rst
diff --git a/networking/using_networking_rtems_app.rst 
b/legacy-networking/using_networking_rtems_app.rst
similarity index 100%
rename from networking/using_networking_rtems_app.rst
rename to legacy-networking/using_networking_rtems_app.rst
diff --git a/networking/wscript b/legacy-networking/wscript
similarity index 100%
rename from networking/wscript
rename to legacy-networking/wscript
diff --git a/wscript b/wscript
index ce644f8..92775ae 100644
--- a/wscript
++

Re: [PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-23 Thread Vijay Kumar Banerjee
Ping :)

On Tue, Mar 9, 2021 at 9:59 AM Vijay Kumar Banerjee  wrote:
>
> ---
>  book/index_book.rst   | 2 +-
>  {networking => legacy-networking}/command.rst | 0
>  {networking => legacy-networking}/conf.py | 4 ++--
>  {networking => legacy-networking}/dec_21140.rst   | 0
>  {networking => legacy-networking}/index.rst   | 2 +-
>  {networking => legacy-networking}/network_servers.rst | 0
>  {networking => legacy-networking}/network_task_structure.rst  | 0
>  {networking => legacy-networking}/networking_driver.rst   | 0
>  {networking => legacy-networking}/preface.rst | 0
>  {networking => legacy-networking}/testing_the_driver.rst  | 0
>  .../using_networking_rtems_app.rst| 0
>  {networking => legacy-networking}/wscript | 0
>  wscript   | 2 +-
>  13 files changed, 5 insertions(+), 5 deletions(-)
>  rename {networking => legacy-networking}/command.rst (100%)
>  rename {networking => legacy-networking}/conf.py (68%)
>  rename {networking => legacy-networking}/dec_21140.rst (100%)
>  rename {networking => legacy-networking}/index.rst (92%)
>  rename {networking => legacy-networking}/network_servers.rst (100%)
>  rename {networking => legacy-networking}/network_task_structure.rst (100%)
>  rename {networking => legacy-networking}/networking_driver.rst (100%)
>  rename {networking => legacy-networking}/preface.rst (100%)
>  rename {networking => legacy-networking}/testing_the_driver.rst (100%)
>  rename {networking => legacy-networking}/using_networking_rtems_app.rst 
> (100%)
>  rename {networking => legacy-networking}/wscript (100%)
>
> diff --git a/book/index_book.rst b/book/index_book.rst
> index 8282006..3fc67d2 100644
> --- a/book/index_book.rst
> +++ b/book/index_book.rst
> @@ -23,7 +23,7 @@ Table of Contents
> cpu_supplement/index.rst
> develenv/index.rst
> filesystem/index.rst
> -   networking/index.rst
> +   legacy_networking/index.rst
> porting/index.rst
> posix1003_1/index.rst
> posix_users/index.rst
> diff --git a/networking/command.rst b/legacy-networking/command.rst
> similarity index 100%
> rename from networking/command.rst
> rename to legacy-networking/command.rst
> diff --git a/networking/conf.py b/legacy-networking/conf.py
> similarity index 68%
> rename from networking/conf.py
> rename to legacy-networking/conf.py
> index 1c129bc..6cc01bc 100644
> --- a/networking/conf.py
> +++ b/legacy-networking/conf.py
> @@ -3,12 +3,12 @@ sys.path.insert(0, os.path.abspath('../common/'))
>
>  from conf import *
>
> -project = "RTEMS Networking User Manual"
> +project = "RTEMS Legacy Networking User Manual"
>
>  latex_documents = [
>  ('index',
>   'networking.tex',
> - u'RTEMS Networking User Manual',
> + u'RTEMS Legacy Networking User Manual',
>   u'RTEMS Documentation Project',
>   'manual'),
>  ]
> diff --git a/networking/dec_21140.rst b/legacy-networking/dec_21140.rst
> similarity index 100%
> rename from networking/dec_21140.rst
> rename to legacy-networking/dec_21140.rst
> diff --git a/networking/index.rst b/legacy-networking/index.rst
> similarity index 92%
> rename from networking/index.rst
> rename to legacy-networking/index.rst
> index f56a60d..b85119d 100644
> --- a/networking/index.rst
> +++ b/legacy-networking/index.rst
> @@ -5,7 +5,7 @@
>  .. highlight:: c
>
>  ==
> -RTEMS Network User Manual (|version|).
> +RTEMS Legacy Network User Manual (|version|).
>  ==
>
>  .. topic:: Copyrights and License
> diff --git a/networking/network_servers.rst 
> b/legacy-networking/network_servers.rst
> similarity index 100%
> rename from networking/network_servers.rst
> rename to legacy-networking/network_servers.rst
> diff --git a/networking/network_task_structure.rst 
> b/legacy-networking/network_task_structure.rst
> similarity index 100%
> rename from networking/network_task_structure.rst
> rename to legacy-networking/network_task_structure.rst
> diff --git a/networking/networking_driver.rst 
> b/legacy-networking/networking_driver.rst
> similarity index 100%
> rename from networking/networking_driver.rst
> rename to legacy-networking/networking_driver.rst
> diff --git a/networking/preface.rst b/legacy-networking/preface.rst
> similarity index 100%
> rename from networking/preface.rst
> rename to legacy-networking/preface.rst
> diff --git a/networking/testing_the_driver.rst 
> b/legacy-networking/testing_the_driver.rst
> similarity index 100%
> rename from networking/testing_the_driver.rst
> rename to legacy-networking/testing_the_driver.rst
> diff --git a/networking/using_networking_rtems_app.rst 
> b/legacy-networking/using_networking_rtems_app.rst
> similarity index 100%
> rename from networking/using_networking_rtems_ap

Re: [PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-23 Thread Joel Sherrill
I'm OK with this.

Does this move the manual to near the bottom of the manual list?

I suspect some content is needed somewhere in the Users Guide
to point out how you have a choice of network stacks and building
one of them. Beyond this patch but looking forward, we have some
explaining to do.

--joel

On Tue, Mar 23, 2021 at 1:48 PM Vijay Kumar Banerjee 
wrote:

> Ping :)
>
> On Tue, Mar 9, 2021 at 9:59 AM Vijay Kumar Banerjee 
> wrote:
> >
> > ---
> >  book/index_book.rst   | 2 +-
> >  {networking => legacy-networking}/command.rst | 0
> >  {networking => legacy-networking}/conf.py | 4 ++--
> >  {networking => legacy-networking}/dec_21140.rst   | 0
> >  {networking => legacy-networking}/index.rst   | 2 +-
> >  {networking => legacy-networking}/network_servers.rst | 0
> >  {networking => legacy-networking}/network_task_structure.rst  | 0
> >  {networking => legacy-networking}/networking_driver.rst   | 0
> >  {networking => legacy-networking}/preface.rst | 0
> >  {networking => legacy-networking}/testing_the_driver.rst  | 0
> >  .../using_networking_rtems_app.rst| 0
> >  {networking => legacy-networking}/wscript | 0
> >  wscript   | 2 +-
> >  13 files changed, 5 insertions(+), 5 deletions(-)
> >  rename {networking => legacy-networking}/command.rst (100%)
> >  rename {networking => legacy-networking}/conf.py (68%)
> >  rename {networking => legacy-networking}/dec_21140.rst (100%)
> >  rename {networking => legacy-networking}/index.rst (92%)
> >  rename {networking => legacy-networking}/network_servers.rst (100%)
> >  rename {networking => legacy-networking}/network_task_structure.rst
> (100%)
> >  rename {networking => legacy-networking}/networking_driver.rst (100%)
> >  rename {networking => legacy-networking}/preface.rst (100%)
> >  rename {networking => legacy-networking}/testing_the_driver.rst (100%)
> >  rename {networking => legacy-networking}/using_networking_rtems_app.rst
> (100%)
> >  rename {networking => legacy-networking}/wscript (100%)
> >
> > diff --git a/book/index_book.rst b/book/index_book.rst
> > index 8282006..3fc67d2 100644
> > --- a/book/index_book.rst
> > +++ b/book/index_book.rst
> > @@ -23,7 +23,7 @@ Table of Contents
> > cpu_supplement/index.rst
> > develenv/index.rst
> > filesystem/index.rst
> > -   networking/index.rst
> > +   legacy_networking/index.rst
> > porting/index.rst
> > posix1003_1/index.rst
> > posix_users/index.rst
> > diff --git a/networking/command.rst b/legacy-networking/command.rst
> > similarity index 100%
> > rename from networking/command.rst
> > rename to legacy-networking/command.rst
> > diff --git a/networking/conf.py b/legacy-networking/conf.py
> > similarity index 68%
> > rename from networking/conf.py
> > rename to legacy-networking/conf.py
> > index 1c129bc..6cc01bc 100644
> > --- a/networking/conf.py
> > +++ b/legacy-networking/conf.py
> > @@ -3,12 +3,12 @@ sys.path.insert(0, os.path.abspath('../common/'))
> >
> >  from conf import *
> >
> > -project = "RTEMS Networking User Manual"
> > +project = "RTEMS Legacy Networking User Manual"
> >
> >  latex_documents = [
> >  ('index',
> >   'networking.tex',
> > - u'RTEMS Networking User Manual',
> > + u'RTEMS Legacy Networking User Manual',
> >   u'RTEMS Documentation Project',
> >   'manual'),
> >  ]
> > diff --git a/networking/dec_21140.rst b/legacy-networking/dec_21140.rst
> > similarity index 100%
> > rename from networking/dec_21140.rst
> > rename to legacy-networking/dec_21140.rst
> > diff --git a/networking/index.rst b/legacy-networking/index.rst
> > similarity index 92%
> > rename from networking/index.rst
> > rename to legacy-networking/index.rst
> > index f56a60d..b85119d 100644
> > --- a/networking/index.rst
> > +++ b/legacy-networking/index.rst
> > @@ -5,7 +5,7 @@
> >  .. highlight:: c
> >
> >  ==
> > -RTEMS Network User Manual (|version|).
> > +RTEMS Legacy Network User Manual (|version|).
> >  ==
> >
> >  .. topic:: Copyrights and License
> > diff --git a/networking/network_servers.rst
> b/legacy-networking/network_servers.rst
> > similarity index 100%
> > rename from networking/network_servers.rst
> > rename to legacy-networking/network_servers.rst
> > diff --git a/networking/network_task_structure.rst
> b/legacy-networking/network_task_structure.rst
> > similarity index 100%
> > rename from networking/network_task_structure.rst
> > rename to legacy-networking/network_task_structure.rst
> > diff --git a/networking/networking_driver.rst
> b/legacy-networking/networking_driver.rst
> > similarity index 100%
> > rename from networking/networking_driver.rst
> > rename to legacy-networking/networking_driver.rst
> > diff

Re: [PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-23 Thread Vijay Kumar Banerjee
Hi,

Thanks for the review.

On Tue, Mar 23, 2021 at 12:56 PM Joel Sherrill  wrote:
>
> I'm OK with this.
>
> Does this move the manual to near the bottom of the manual list?
>
No, it doesn't. I just sent a v3 to add this. I have also sent a patch
to fix the docs build for python 3.5 and up.

> I suspect some content is needed somewhere in the Users Guide
> to point out how you have a choice of network stacks and building
> one of them. Beyond this patch but looking forward, we have some
> explaining to do.
>
Yes, I'm planning to write documentation about the different network
stack available in rtems and how would a user select between them.
This can be a section in the user manual.

Best regards,
Vijay
> --joel
>
> On Tue, Mar 23, 2021 at 1:48 PM Vijay Kumar Banerjee  wrote:
>>
>> Ping :)
>>
>> On Tue, Mar 9, 2021 at 9:59 AM Vijay Kumar Banerjee  wrote:
>> >
>> > ---
>> >  book/index_book.rst   | 2 +-
>> >  {networking => legacy-networking}/command.rst | 0
>> >  {networking => legacy-networking}/conf.py | 4 ++--
>> >  {networking => legacy-networking}/dec_21140.rst   | 0
>> >  {networking => legacy-networking}/index.rst   | 2 +-
>> >  {networking => legacy-networking}/network_servers.rst | 0
>> >  {networking => legacy-networking}/network_task_structure.rst  | 0
>> >  {networking => legacy-networking}/networking_driver.rst   | 0
>> >  {networking => legacy-networking}/preface.rst | 0
>> >  {networking => legacy-networking}/testing_the_driver.rst  | 0
>> >  .../using_networking_rtems_app.rst| 0
>> >  {networking => legacy-networking}/wscript | 0
>> >  wscript   | 2 +-
>> >  13 files changed, 5 insertions(+), 5 deletions(-)
>> >  rename {networking => legacy-networking}/command.rst (100%)
>> >  rename {networking => legacy-networking}/conf.py (68%)
>> >  rename {networking => legacy-networking}/dec_21140.rst (100%)
>> >  rename {networking => legacy-networking}/index.rst (92%)
>> >  rename {networking => legacy-networking}/network_servers.rst (100%)
>> >  rename {networking => legacy-networking}/network_task_structure.rst (100%)
>> >  rename {networking => legacy-networking}/networking_driver.rst (100%)
>> >  rename {networking => legacy-networking}/preface.rst (100%)
>> >  rename {networking => legacy-networking}/testing_the_driver.rst (100%)
>> >  rename {networking => legacy-networking}/using_networking_rtems_app.rst 
>> > (100%)
>> >  rename {networking => legacy-networking}/wscript (100%)
>> >
>> > diff --git a/book/index_book.rst b/book/index_book.rst
>> > index 8282006..3fc67d2 100644
>> > --- a/book/index_book.rst
>> > +++ b/book/index_book.rst
>> > @@ -23,7 +23,7 @@ Table of Contents
>> > cpu_supplement/index.rst
>> > develenv/index.rst
>> > filesystem/index.rst
>> > -   networking/index.rst
>> > +   legacy_networking/index.rst
>> > porting/index.rst
>> > posix1003_1/index.rst
>> > posix_users/index.rst
>> > diff --git a/networking/command.rst b/legacy-networking/command.rst
>> > similarity index 100%
>> > rename from networking/command.rst
>> > rename to legacy-networking/command.rst
>> > diff --git a/networking/conf.py b/legacy-networking/conf.py
>> > similarity index 68%
>> > rename from networking/conf.py
>> > rename to legacy-networking/conf.py
>> > index 1c129bc..6cc01bc 100644
>> > --- a/networking/conf.py
>> > +++ b/legacy-networking/conf.py
>> > @@ -3,12 +3,12 @@ sys.path.insert(0, os.path.abspath('../common/'))
>> >
>> >  from conf import *
>> >
>> > -project = "RTEMS Networking User Manual"
>> > +project = "RTEMS Legacy Networking User Manual"
>> >
>> >  latex_documents = [
>> >  ('index',
>> >   'networking.tex',
>> > - u'RTEMS Networking User Manual',
>> > + u'RTEMS Legacy Networking User Manual',
>> >   u'RTEMS Documentation Project',
>> >   'manual'),
>> >  ]
>> > diff --git a/networking/dec_21140.rst b/legacy-networking/dec_21140.rst
>> > similarity index 100%
>> > rename from networking/dec_21140.rst
>> > rename to legacy-networking/dec_21140.rst
>> > diff --git a/networking/index.rst b/legacy-networking/index.rst
>> > similarity index 92%
>> > rename from networking/index.rst
>> > rename to legacy-networking/index.rst
>> > index f56a60d..b85119d 100644
>> > --- a/networking/index.rst
>> > +++ b/legacy-networking/index.rst
>> > @@ -5,7 +5,7 @@
>> >  .. highlight:: c
>> >
>> >  ==
>> > -RTEMS Network User Manual (|version|).
>> > +RTEMS Legacy Network User Manual (|version|).
>> >  ==
>> >
>> >  .. topic:: Copyrights and License
>> > diff --git a/networking/network_servers.rst 
>> > b/legacy-networking/network_servers.rst
>> > similarity index 100%
>> > rename from networking/network_servers.rst
>> > 

Re: [PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-23 Thread Chris Johns
On 24/3/21 7:08 am, Vijay Kumar Banerjee wrote:
> Hi,
> 
> Thanks for the review.
> 
> On Tue, Mar 23, 2021 at 12:56 PM Joel Sherrill  wrote:
>>
>> I'm OK with this.
>>
>> Does this move the manual to near the bottom of the manual list?
>>
> No, it doesn't. 

The order is set by the order in this list ...

https://git.rtems.org/rtems-docs/tree/wscript#n25

This list us used to create the XML catalogue that is read downby the JS code
loaded when you visit the web page.

Chris
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel


Re: [PATCH rtems-docs v2] networking: Rename to legacy networking

2021-03-23 Thread Vijay Kumar Banerjee
On Tue, Mar 23, 2021 at 3:16 PM Chris Johns  wrote:
>
> On 24/3/21 7:08 am, Vijay Kumar Banerjee wrote:
> > Hi,
> >
> > Thanks for the review.
> >
> > On Tue, Mar 23, 2021 at 12:56 PM Joel Sherrill  wrote:
> >>
> >> I'm OK with this.
> >>
> >> Does this move the manual to near the bottom of the manual list?
> >>
> > No, it doesn't.
>
> The order is set by the order in this list ...
>
Hi Chris,

> https://git.rtems.org/rtems-docs/tree/wscript#n25
>
Thanks for the reference. I figured it out by trial-and-error and sent
a v3 of this patch.

Best regards,
Vijay

> This list us used to create the XML catalogue that is read downby the JS code
> loaded when you visit the web page.
>
> Chris
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel