Hello,
since I began to use RTT-2, I found many errors in the documentation (mostly
typos). What's the best way to submit these things? Do I have to post a mail
each time I find something or there's a way to modify the documentation like
it's possible with the wiki?
Philippe Hamelin
Proper way to submit errors in documentation?
On Thursday 02 December 2010 14:10:19 Philippe Hamelin wrote:
> Hello,
>
> since I began to use RTT-2, I found many errors in the documentation
> (mostly typos). What's the best way to submit these things? Do I have to
> post a mail each time I find something or there's a way to modify the
> documentation like it's possible with the wiki?
The manuals are in xml format in the rtt/doc/xml directory. I use emacs +
nxml-mode to edit these. The best way is to send patches.
Peter
Proper way to submit errors in documentation?
Here is one for the Corba manual.
2010/12/2 Peter Soetens <peter [..] ...>
> On Thursday 02 December 2010 14:10:19 Philippe Hamelin wrote:
> > Hello,
> >
> > since I began to use RTT-2, I found many errors in the documentation
> > (mostly typos). What's the best way to submit these things? Do I have to
> > post a mail each time I find something or there's a way to modify the
> > documentation like it's possible with the wiki?
>
> The manuals are in xml format in the rtt/doc/xml directory. I use emacs +
> nxml-mode to edit these. The best way is to send patches.
>
> Peter
>
Proper way to submit errors in documentation?
On Thursday 02 December 2010 16:06:24 Philippe Hamelin wrote:
> Here is one for the Corba manual.
>
Thanks.
If you would be using the git tree. You could have done:
git add doc/xml/orocos-transports-corba.xml
git commit -sm"doc: fix corba initialisation example."
git format-patch HEAD~1
And email the result (using git send-email or manually).
A later 'pull' would have noticed that your patch has been merged upstream,
and removed the patch from your HEAD.
Peter
Proper way to submit errors in documentation?
The GIT port is blocked by our TI and I didn't find any way to clone the
gitorious repository through HTTP. I tried:
git clone http://git.gitorious.org/orocos-toolchain/rtt.git
but it doesn't seems to work at all. Any suggestions?
Philippe
2010/12/3 Peter Soetens <peter [..] ...>
> On Thursday 02 December 2010 16:06:24 Philippe Hamelin wrote:
> > Here is one for the Corba manual.
> >
>
> Thanks.
>
> If you would be using the git tree. You could have done:
>
> git add doc/xml/orocos-transports-corba.xml
> git commit -sm"doc: fix corba initialisation example."
> git format-patch HEAD~1
>
> And email the result (using git send-email or manually).
>
> A later 'pull' would have noticed that your patch has been merged upstream,
> and removed the patch from your HEAD.
>
> Peter
>
>
Proper way to submit errors in documentation?
Never mind.... was a network problem :-|
2010/12/3 Philippe Hamelin <philippe [dot] hamelin [..] ...>
> The GIT port is blocked by our TI and I didn't find any way to clone the
> gitorious repository through HTTP. I tried:
>
> git clone http://git.gitorious.org/orocos-toolchain/rtt.git
>
> but it doesn't seems to work at all. Any suggestions?
>
> Philippe
>
> 2010/12/3 Peter Soetens <peter [..] ...>
>
> On Thursday 02 December 2010 16:06:24 Philippe Hamelin wrote:
>> > Here is one for the Corba manual.
>> >
>>
>> Thanks.
>>
>> If you would be using the git tree. You could have done:
>>
>> git add doc/xml/orocos-transports-corba.xml
>> git commit -sm"doc: fix corba initialisation example."
>> git format-patch HEAD~1
>>
>> And email the result (using git send-email or manually).
>>
>> A later 'pull' would have noticed that your patch has been merged
>> upstream,
>> and removed the patch from your HEAD.
>>
>> Peter
>>
>>
>