discuss: Thread: RTLinux HOWTO

Hello all!

A document named "RTLinux HOWTO" exists in the LDP. It describes installation 
and writing your own modules for RTLinux, the realtime extension to the Linux 
kernel. However, the installation instructions (and, partially, the 
programming tutorials) provided there are very outdated - they are for 
RTLinux 2.x, whereas the current release is 3.2 and lots of things have 
changed since 2002 when this HOWTO was last modified.

The thing is that I've been working with RLinux for a while, and I wrote my 
own installation instructions, and I they are now part of the official 
RTLinux package - so these are THE instructions :-) (While I was discussing 
things on rtlinux list, many people asked for such instructions, so I wrote 
them not to describe them each and every time a newbie asks, and then RTLinux 
guys asked if they can include my docs in the distribution)

Now, I improved these instructions and converted to DocBook. You will find the 
first version of my RTLinux Installation HOWTO at my LinuxDocs site:
http://artemio.net/projects/linuxdoc/rtlinux

So, there are two questions/solutions:

1. Should I take the original RTLinux HOWTO, and replace/update the 
installation instructions with mine?

 - or - 

2. Should I remove the installation insructions from RTLinux HOWTO and turn it 
into RTLinux Programming HOWTO (I can rewrite it in DocBook/XML as well), and 
then there will be two HOWTOs: RTLinux Installation HOWTO and RTLinux 
Programming HOWTO (or, RTLinux Module Programming HOWTO).

I think the latter will be better.

Any suggestions would be appreciated.



Sincerely,
Artemio.
-- 
KDEvibes ::: audio environment for KDE ::: 
http://artemio.net/projects/kdevibes
[local time 09:59:44 (GMT +3) 25 May 2004] [system uptime 1 hr 45 min]

On Tue, May 25, 2004 at 10:12:41AM +0300, Artemio wrote:
> Hello all!

Hello


> The thing is that I've been working with RLinux for a while, and I wrote my 
> own installation instructions, and I they are now part of the official 
> RTLinux package - so these are THE instructions :-) (While I was discussing 
> things on rtlinux list, many people asked for such instructions, so I wrote 
> them not to describe them each and every time a newbie asks, and then RTLinux 
> guys asked if they can include my docs in the distribution)
> 
> Now, I improved these instructions and converted to DocBook. You will find the 
> first version of my RTLinux Installation HOWTO at my LinuxDocs site:
> http://artemio.net/projects/linuxdoc/rtlinux
> 
> So, there are two questions/solutions:
> 
> 1. Should I take the original RTLinux HOWTO, and replace/update the 
> installation instructions with mine?
> 
>  - or - 
> 
> 2. Should I remove the installation insructions from RTLinux HOWTO and turn it 
> into RTLinux Programming HOWTO (I can rewrite it in DocBook/XML as well), and 
> then there will be two HOWTOs: RTLinux Installation HOWTO and RTLinux 
> Programming HOWTO (or, RTLinux Module Programming HOWTO).
> 
> I think the latter will be better.
> 
> Any suggestions would be appreciated.

The RTLinux-HOWTO hasn't been updated since 2002.  I would suggest you
email the author (the email address appears to be currently correct).
Suggest your plan, similar to what you presented here, then let us know
what happens.

I think your plan is good.

-- 
Doug Jensen

Hello!

The first message I sent him was not replied, and all the 
further tries I made failed with the following message from the mail server:

####@####.####
    SMTP error from remote mailer after RCPT 
####@####.####
    host mail2.rediffmail.com [203.199.83.4]: 553 sorry, your envelope sender 
is in my badmailfrom list (#5.7.1)

I will wait for a while anyway, but next week I'll likely start making my plan 
come true.

There will also be a question to discuss - e.g. I want to move the contents of 
RTLinux HOWTO to RTLinux Module Programming HOWTO (I'll rewrite it in more 
"modern" DocBook), and completely replace it with my own installation 
instructions HOWTO. How can I do that? I mean, since the new RTLinux HOWTO 
will be mine entirely, do I have to put the old author anyway? Will it be 
okay to move the old but renowned programming-related material to a new howto 
- the author will remain the same, as in the old version of RTLinux howto.



Artemio.
-- 
ArtemioLabs ::: innovative audio laboratories ::: http://artemiolabs.com
[local time 19:42:43 (GMT +3) 1 June 2004] [system uptime 34 min]

I have emailed the author as well. Hopefully they will be willing to
transfer the maintenance/co-authorship of the document to you.

On Tue, Jun 01, 2004 at 07:45:21PM +0300, Artemio wrote:
> There will also be a question to discuss - e.g. I want to move the contents of 
> RTLinux HOWTO to RTLinux Module Programming HOWTO (I'll rewrite it in more 
> "modern" DocBook), and completely replace it with my own installation 
> instructions HOWTO. How can I do that? I mean, since the new RTLinux HOWTO 
> will be mine entirely, do I have to put the old author anyway? Will it be 
> okay to move the old but renowned programming-related material to a new howto 
> - the author will remain the same, as in the old version of RTLinux howto.

As an open source project we always feel that it is best to give credit to
the original authors and maintain their names in future versions. The spirit 
of the project is not to entirely replace documents because they are now old, 
but rather to build on the work of those who came before us. 

emma

-- 
Emma Jane Hogbin
Technical Review Coordinator
The Linux Documentation Project
www.tldp.org

Dear Emma,

have yot any reply from the original author of RTLinux HOWTO?

If not, here is my plan and my questions:

1. I take the original RTLinux HOWTO and [1] remove all old installation 
instructions [2] update the programming tutorials if needed [3] rename the 
doc to RTLinux Module Programming HOWTO and it gets published at TLDP.

2. Question: should I rename my new howto to RTLinux Installation HOWTO? In 
this case, the RTLinux HOWTO should be deleted off the TLDP. Is this 
possible? Of no, I will rename my doc to RTLinux HOWTO so it completely 
replaces the old doc which will move to RTLinux Module Programming HOWTO.

Basically, this is all I need.

Hoping to hear some comments, suggestions, ideas.

Thanks and good luck!


Artemio.
-- 
A-Man ::: new music from Artemio ::: http://a-man.artemio.net
[local time 11:28:13 (GMT +3) 4 June 2004] [system uptime 1 hr 31 min]

Artemio wrote:
> Dear Emma,
> 
> have yot any reply from the original author of RTLinux HOWTO?
> 
> If not, here is my plan and my questions:
> 
> 1. I take the original RTLinux HOWTO and [1] remove all old installation 
> instructions [2] update the programming tutorials if needed [3] rename the 
> doc to RTLinux Module Programming HOWTO and it gets published at TLDP.
> 
> 2. Question: should I rename my new howto to RTLinux Installation HOWTO? In 
> this case, the RTLinux HOWTO should be deleted off the TLDP. Is this 
> possible? Of no, I will rename my doc to RTLinux HOWTO so it completely 
> replaces the old doc which will move to RTLinux Module Programming HOWTO.

If you remove any reference to the present RTLinux which you say is 
outdated.  What do I reference if I need information for my older hardware?

My suggestion would be to rename it with a kernel version or earlier tag.

Dave