Xenomai Wiki updates

Xenomai Wiki updates

[Per Oberg]

Hi

I was looking at the Xenomai Wiki and noticed that there were some outdated information.

E.g. : 

* https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
Dovetail, kernel git trees and recommendations are not mentioned. There is a section on the powerpc part which I seem to remember has been deprecated. 

 
* https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
Embedded Linux distributions & Xenomai points to ELDK which seems to be no longer available. 


I think I might find some time update some of the stuff. What are the guidelines and procedure to contribute to th Wiki ?

Per Öberg 

Re: Xenomai Wiki updates

[Jan Kiszka]

On 04.09.23 12:14, Per Oberg wrote:
> Hi
> 
> I was looking at the Xenomai Wiki and noticed that there were some outdated information.
> 
> E.g. : 
> 
> * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
> Dovetail, kernel git trees and recommendations are not mentioned. There is a section on the powerpc part which I seem to remember has been deprecated. 
> 
>  
> * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
> Embedded Linux distributions & Xenomai points to ELDK which seems to be no longer available. 
> 
> 
> I think I might find some time update some of the stuff. What are the guidelines and procedure to contribute to th Wiki ?

The landing page(s) are being reworked right now, and that will widely
replace the wiki-based homepage. Will probably surface other issues. If
you like to check that instead: https://v3.xenomai.org. Feedback highly
appreciated!

Thanks,
Jan

-- 
Siemens AG, Technology
Linux Expert Center

Re: Xenomai Wiki updates

[Philippe Gerum]

Per Oberg <pero@wolfram.com> writes:

> Hi
>
> I was looking at the Xenomai Wiki and noticed that there were some outdated information.
>
> E.g. : 
>
> * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
> Dovetail, kernel git trees and recommendations are not mentioned. There is a section on the powerpc part which I seem to remember has been deprecated. 
>
>  
> * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
> Embedded Linux distributions & Xenomai points to ELDK which seems to be no longer available. 
>

Significant updates to the v3 documentation is direly needed for sure.

>
> I think I might find some time update some of the stuff. What are the guidelines and procedure to contribute to th Wiki ?
>

The content of the upcoming website at v3.xenomai.org is maintained in a
git tree, which is now public. This is a Hugo generated (static) site
using the 'learn' theme, see [2][3]. Likewise for Xenomai 4/evl at
v4.xenomai.org, content available as a git tree from [4].

The workflow is pretty simple:

- apt/dnf install the 'hugo' package
- git clone the website repo
- make changes to $repo/content/*

hugo provides a local web server [5] serving the pages in $repo to a
local browser, which automatically renders any update live:

- cd $repo
- hugo server

The website should be accessible from localhost:1313.

Contributions are welcome, patches should be sent to this list.

[1] https://source.denx.de/Xenomai/website.git
[2] https://gohugo.io/
[3] https://learn.netlify.app/en/
[4] https://source.denx.de/Xenomai/xenomai4/website.git
[5] https://gohugo.io/commands/hugo_server/

-- 
Philippe.

Re: Xenomai Wiki updates

[Per Oberg]

----- Den 4 sep 2023, på kl 14:20, Jan Kiszka jan.kiszka@siemens.com skrev:

> On 04.09.23 12:14, Per Oberg wrote:
> > Hi

>> I was looking at the Xenomai Wiki and noticed that there were some outdated
> > information.

> > E.g. :

> > * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
>> Dovetail, kernel git trees and recommendations are not mentioned. There is a
> > section on the powerpc part which I seem to remember has been deprecated.


> > * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
>> Embedded Linux distributions & Xenomai points to ELDK which seems to be no
> > longer available.


>> I think I might find some time update some of the stuff. What are the guidelines
> > and procedure to contribute to th Wiki ?

> The landing page(s) are being reworked right now, and that will widely
> replace the wiki-based homepage. Will probably surface other issues. If
> you like to check that instead: https://v3.xenomai.org. Feedback highly
> appreciated!

> Thanks,
> Jan

> --
> Siemens AG, Technology
> Linux Expert Center

Thanks, I am currently looking at this and I will try to get back with feedback and patches when I find the time. 

Some early notes:

* It's a bit unclear the relation between dovetail and evl. It's not obvious that dovetail
   is available for Xenomai 3 depending on kernel version.

* The Xenomai3 installation page [1] mixes "--ipipe" and "--dovetail" where "--ipipe" 
  is used in the black box and "--dovetail" in the list below. 

* The installation page [1] only talkes about the "prepare-kernel.sh" approach. I always 
  found that approach a little error prone because it is necessary to find a kernel matching 
  the version to patch. Perhaps it is better these days but for very special hardware it 
  used to be hard to find the exakt version as time went by. So, it seems like the simpler 
  approach is to check out the git-versioned variant available in the tree. Perhaps the 
  installation page could mention the git-tree approach.


[1] https://v3.xenomai.org/installation/


Per Öberg 

Re: Xenomai Wiki updates

[Per Oberg]

----- Den 12 sep 2023, på kl 17:30, Per Öberg pero@wolfram.com skrev:

> ----- Den 4 sep 2023, på kl 14:20, Jan Kiszka jan.kiszka@siemens.com skrev:

> > On 04.09.23 12:14, Per Oberg wrote:
> > > Hi

> >> I was looking at the Xenomai Wiki and noticed that there were some outdated
> > > information.

> > > E.g. :

> > > * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
> >> Dovetail, kernel git trees and recommendations are not mentioned. There is a
> > > section on the powerpc part which I seem to remember has been deprecated.

> > > * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
> >> Embedded Linux distributions & Xenomai points to ELDK which seems to be no
> > > longer available.

> >> I think I might find some time update some of the stuff. What are the guidelines
> > > and procedure to contribute to th Wiki ?

> > The landing page(s) are being reworked right now, and that will widely
> > replace the wiki-based homepage. Will probably surface other issues. If
> > you like to check that instead: https://v3.xenomai.org. Feedback highly
> > appreciated!

> > Thanks,
> > Jan

> > --
> > Siemens AG, Technology
> > Linux Expert Center

> Thanks, I am currently looking at this and I will try to get back with feedback
> and patches when I find the time.

> Some early notes:

> * It's a bit unclear the relation between dovetail and evl. It's not obvious
> that dovetail
> is available for Xenomai 3 depending on kernel version.

> * The Xenomai3 installation page [1] mixes "--ipipe" and "--dovetail" where
> "--ipipe"
> is used in the black box and "--dovetail" in the list below.

> * The installation page [1] only talkes about the "prepare-kernel.sh" approach.
> I always
> found that approach a little error prone because it is necessary to find a
> kernel matching
> the version to patch. Perhaps it is better these days but for very special
> hardware it
> used to be hard to find the exakt version as time went by. So, it seems like the
> simpler
> approach is to check out the git-versioned variant available in the tree.
> Perhaps the
> installation page could mention the git-tree approach.

> [1] https://v3.xenomai.org/installation/

> Per Öberg

Answering myself here...

What I meant with "The installation page [1] only talkes about the "prepare-kernel.sh" approach." was the use of "--ipipe" or "--dovetail" separately, I think. 

Per Öberg 

Re: Xenomai Wiki updates

[Jan Kiszka]

On 12.09.23 21:17, Per Oberg wrote:
> 
> ----- Den 12 sep 2023, på kl 17:30, Per Öberg pero@wolfram.com skrev:
> 
>> ----- Den 4 sep 2023, på kl 14:20, Jan Kiszka jan.kiszka@siemens.com skrev:
> 
>>> On 04.09.23 12:14, Per Oberg wrote:
>>>> Hi
> 
>>>> I was looking at the Xenomai Wiki and noticed that there were some outdated
>>>> information.
> 
>>>> E.g. :
> 
>>>> * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
>>>> Dovetail, kernel git trees and recommendations are not mentioned. There is a
>>>> section on the powerpc part which I seem to remember has been deprecated.
> 
>>>> * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
>>>> Embedded Linux distributions & Xenomai points to ELDK which seems to be no
>>>> longer available.
> 
>>>> I think I might find some time update some of the stuff. What are the guidelines
>>>> and procedure to contribute to th Wiki ?
> 
>>> The landing page(s) are being reworked right now, and that will widely
>>> replace the wiki-based homepage. Will probably surface other issues. If
>>> you like to check that instead: https://v3.xenomai.org. Feedback highly
>>> appreciated!
> 
>>> Thanks,
>>> Jan
> 
>>> --
>>> Siemens AG, Technology
>>> Linux Expert Center
> 
>> Thanks, I am currently looking at this and I will try to get back with feedback
>> and patches when I find the time.
> 
>> Some early notes:
> 
>> * It's a bit unclear the relation between dovetail and evl. It's not obvious
>> that dovetail
>> is available for Xenomai 3 depending on kernel version.
> 
>> * The Xenomai3 installation page [1] mixes "--ipipe" and "--dovetail" where
>> "--ipipe"
>> is used in the black box and "--dovetail" in the list below.
> 
>> * The installation page [1] only talkes about the "prepare-kernel.sh" approach.
>> I always
>> found that approach a little error prone because it is necessary to find a
>> kernel matching
>> the version to patch. Perhaps it is better these days but for very special
>> hardware it
>> used to be hard to find the exakt version as time went by. So, it seems like the
>> simpler
>> approach is to check out the git-versioned variant available in the tree.
>> Perhaps the
>> installation page could mention the git-tree approach.
> 
>> [1] https://v3.xenomai.org/installation/
> 
>> Per Öberg
> 
> Answering myself here...
> 
> What I meant with "The installation page [1] only talkes about the "prepare-kernel.sh" approach." was the use of "--ipipe" or "--dovetail" separately, I think. 
> 
> Per Öberg 
> 

Are you able to send merge requests against [0]? Otherwise, please send
patches to the list, marking them as "[website][PATCH] ...".

Thank a lot already for your findings!

Jan

[0]
https://source.denx.de/Xenomai/website/-/blob/master/content/installation/_index.md?ref_type=heads

-- 
Siemens AG, Technology
Linux Expert Center

Re: Xenomai Wiki updates

[Per Oberg]

----- Den 12 sep 2023, på kl 19:21, Jan Kiszka jan.kiszka@siemens.com skrev:

> On 12.09.23 21:17, Per Oberg wrote:

> > ----- Den 12 sep 2023, på kl 17:30, Per Öberg pero@wolfram.com skrev:

> >> ----- Den 4 sep 2023, på kl 14:20, Jan Kiszka jan.kiszka@siemens.com skrev:

> >>> On 04.09.23 12:14, Per Oberg wrote:
> >>>> Hi

> >>>> I was looking at the Xenomai Wiki and noticed that there were some outdated
> >>>> information.

> >>>> E.g. :

> >>>> * https://source.denx.de/Xenomai/xenomai/-/wikis/Installing_Xenomai_3
> >>>> Dovetail, kernel git trees and recommendations are not mentioned. There is a
> >>>> section on the powerpc part which I seem to remember has been deprecated.

> >>>> * https://source.denx.de/Xenomai/xenomai/-/wikis/Start_Here
> >>>> Embedded Linux distributions & Xenomai points to ELDK which seems to be no
> >>>> longer available.

> >>>> I think I might find some time update some of the stuff. What are the guidelines
> >>>> and procedure to contribute to th Wiki ?

> >>> The landing page(s) are being reworked right now, and that will widely
> >>> replace the wiki-based homepage. Will probably surface other issues. If
> >>> you like to check that instead: https://v3.xenomai.org. Feedback highly
> >>> appreciated!

> >>> Thanks,
> >>> Jan

> >>> --
> >>> Siemens AG, Technology
> >>> Linux Expert Center

> >> Thanks, I am currently looking at this and I will try to get back with feedback
> >> and patches when I find the time.

> >> Some early notes:

> >> * It's a bit unclear the relation between dovetail and evl. It's not obvious
> >> that dovetail
> >> is available for Xenomai 3 depending on kernel version.

> >> * The Xenomai3 installation page [1] mixes "--ipipe" and "--dovetail" where
> >> "--ipipe"
> >> is used in the black box and "--dovetail" in the list below.

> >> * The installation page [1] only talkes about the "prepare-kernel.sh" approach.
> >> I always
> >> found that approach a little error prone because it is necessary to find a
> >> kernel matching
> >> the version to patch. Perhaps it is better these days but for very special
> >> hardware it
> >> used to be hard to find the exakt version as time went by. So, it seems like the
> >> simpler
> >> approach is to check out the git-versioned variant available in the tree.
> >> Perhaps the
> >> installation page could mention the git-tree approach.

> >> [1] https://v3.xenomai.org/installation/

> >> Per Öberg

> > Answering myself here...

>> What I meant with "The installation page [1] only talkes about the
>> "prepare-kernel.sh" approach." was the use of "--ipipe" or "--dovetail"
> > separately, I think.

> > Per Öberg


> Are you able to send merge requests against [0]? Otherwise, please send
> patches to the list, marking them as "[website][PATCH] ...".

> Thank a lot already for your findings!

> Jan

> [0]
> https://source.denx.de/Xenomai/website/-/blob/master/content/installation/_index.md?ref_type=heads

> --
> Siemens AG, Technology
> Linux Expert Center

I will give it a go!

Thanks
Per Öberg