Enhancement #1703

Improve documentation for creating your own Data Types

Added by C. Dreyer about 10 years ago. Updated over 8 years ago.

Status:RejectedStart date:12/20/2013
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:documentation
Target version:Robotics Service Bus - rsb-0.13

Description

After installing RSX using the prebuild windows zip file
I tried to create my own RST Data Type.
Following the instructions on "Adding new Data Types"
http://docs.cor-lab.de//rst-manual/0.9/html/developer-tutorial.html
I did:

git clone -b 0.9 https://code.cor-lab.org/git/rst.git rst-proto
git checkout -b 0.9-fleximon

wich resulted in a directory
C:\rsx\src\rst-proto\rst-proto\

The Documentation tells me to "Add a proto file for the new data type and test it by building your local branch from source as documented in From Source." refering to to http://docs.cor-lab.de//rst-manual/0.9/html/install.html#installation-from-source

I assume I had to add my protofile into C:\rsx\src\rst-proto\rst-proto

In the documentation on building from source it states at the beginning to clone the rst.git rep.

$ git clone -b 0.9 --recursive https://code.cor-lab.org/git/rst.git

being in C:\rsx\src\rst-proto\rst-proto
this would result in
C:\rsx\src\rst-proto\rst-proto\rst\*
I assume this is not intended !

omitting the cloning step, since i already did

git clone -b 0.9 https://code.cor-lab.org/git/rst.git rst-proto
git checkout -b 0.9-fleximon

from the other page.
I would continue with:
$ cd rst/rst-proto # after "git clone" command
$ mkdir -p build && cd build

wich results in an empty C:\rsx\src\rst-proto\rst-proto\build\
with my flexicode.proto in C:\rsx\src\rst-proto\rst-proto\

continueing with

$ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=PREFIX ..
$ make
$ make install

would try to execute a cmake on a CMakeLists.txt in C:\rsx\src\rst-proto\rst-proto\
which does not exist. There is only my proto file.

I - again - assumed you wanted me to checkout

git checkout -b 0.9-fleximon

being inside the ./rst-proto of
$ git clone -b 0.9 --recursive https://code.cor-lab.org/git/rst.git

with my fleximon.proto being in C:\rsx\src\rst\rst-proto

Following this assumption I tried

$ cd rst/rst-proto # after "git clone" command
$ mkdir -p build && cd build
$ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=PREFIX ..
$ make
$ make install

which resulted in missing boost error although it is exactly where the windows prebuild put it. @C:\rsx\boost@

specifying the boost location manually
<pre>
$ cmake -DBOOST_ROOT=C:\rsx\boost -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=PREFIX .. 
</pre>

resulted again in an missing CMakeLists.txt error!

At that time I went to get a coffee!


Related issues

Related to Robotics Systems Types - Tasks #1270: The manual should explain how to document new data types Resolved 11/29/2012

History

#1 Updated by J. Wienke about 10 years ago

  • Subject changed from creating your own Data Types to Improve documentation for creating your own Data Types
  • Target version set to rsb-0.9

Jan, will you improve this?

#2 Updated by J. Moringen about 10 years ago

I lost track what was going on here.

Let's discuss this next year.

#3 Updated by J. Wienke about 10 years ago

  • Tracker changed from Bug to Enhancement

#4 Updated by J. Moringen almost 10 years ago

  • Target version changed from rsb-0.9 to rsb-0.12

#5 Updated by J. Wienke almost 9 years ago

  • Target version changed from rsb-0.12 to rsb-0.13

#6 Updated by J. Wienke over 8 years ago

  • Related to Tasks #1270: The manual should explain how to document new data types added

#7 Updated by J. Moringen over 8 years ago

  • Status changed from New to Rejected

Please retry with the current RST version and reopen the issue if the problem still exists.

Also available in: Atom PDF