BSP Wiki Clean Up

Mon Mar 30 19:16:36 UTC 2020

As a general rule, any reference to Skyeye or Test Results can be deleted.
Skyeye is dead. The Test Results are horribly out of date and those can be
deleted from any BSP wiki page.  Skyeye and Test Results are a general rule
across all these pages.

Some pages have a mix of template and useful information. When I say
something like save and move to Users Guide, I mean use a bit of judgment
and don't take the template. Extract the good part.

  When reading the board descriptions, some is clearly  cut and paste from
the vendor's site. Sometimes that can be cleaned up a bit and moved to the
Users Guide. A simple description of a board is nice there but not "best
board ever for embedded systems" or "available in volume" type of
language.

Adding small tasks tickets (tags "small, tasks") is OK but it would be
awesome (hint) to just go ahead and convert the good stuff to the Users
Guide and submit a patch.

On Mon, Mar 30, 2020 at 1:22 PM Mritunjay Sharma <
mritunjaysharma394 at gmail.com> wrote:

> Looking for BSP pages with minimal descriptions, I have come across these
> initally:
>
> ARM BSPs
> 1) Cogent CSB337 -- csb337
>

Deleted. Please update master page to delete the link to this.

Ditto for csb336.

> 2) RTL22xx (Philips/NXP ARM7) -- rtl22xx
>

This one looks OK but

>
> Lattice Mico32 BSPs
> 1) Lattice EVR 32
>

Deleted. Please update master page to delete the link to this.

>
> Motorola M68xxx and Coldfire BSPs
> 1)Motorola MCF5206Elite -- mcf5206elite
>

Deleted. Please update master page to delete the link to this.

> 2)Motorola MCF5329EVB -- mcf5329
>

The first paragraph of the overview can be moved to the Users Guide. If you
can find the manual for one online, a link to that would be great in the
users guide.

Submit a patch for that or file a "small tasks" ticket for this.

3)Freescale MCF548x -- genmcf548x
>

Grrr... there is useful info in here but formatted terribly. :(

> 4)Motorola MVME162 -- mvme162 (only Debugging part missing)
>

This should be converted to the Users Guide.  The Overview reads like a cut
and paste from the web description of the board but the board setup info is
valuable.

5)Cogent CSB360 -- csb360 (Both Download and debugging missing)
>

Deleted. Please update master page to delete the link to this.

>
> MIPS BSPs
> 1)Cogent CSB250 and CSB350 -- csb350
>

Overview and Recovering UMon should go to Users Guide. Then the page
deleted.

File a small tasks ticket or just submit a patch to do this.

> 2)Hurricane V320USC -- v320usc
>

Deleted. Please update master page to delete the link to this.

> 3)Toshiba RBTX4925 -- rbtx4925 (Both Download and debugging missing)
>

The useful information should be migrated to the Users Guide. File small
tasks ticket or just submit a patch (even better).

>

> 4)Toshiba RBTX4938 -- rbtx4938 (Both Download and debugging missing)
>

The useful information should be migrated to the Users Guide. File small
tasks ticket or just submit a patch (even better).

>
> PowerPC BSPs
> 1)BAE RAD750 3U and 6U -- rad750
>

I'm willing to delete this but I think there should be a small mention of
the board in the Users Guide. This is a controlled distribution BSP from
NASA. It would be nice to let people know it exists. Not sure what others
think

> 2)Embedded Planet EP5200 -- gen5200 (Both Download and debugging missing)
>

What is there is useful. It should be moved to the Users Guide.

> 3)Lauterbach Trace32 PowerPC Simulator -- t32mppc
>

What is there is useful. It should be moved to the Users Guide.

> 4)Motorola MPC8260 ADS -- mpc8260ads
>

Deleted. Please update master page to delete the link to this.

> 5)Motorola MTX603e -- mtx603e
>

This has some useful information plus template. Useful to the Users Guide.

> 6)TQ Components TQM8xx -- tqm8xx
>

Deleted. Please update master page to delete the link to this.

>
> Most of the other PowerPC BSPs pages lack information related to
> downloading and debugging but have other things in detail,
> How should I consider them?
>

Migrate useful content to Users Guide one BSP at a time. Hopefully the
instructions at the top will help.

>
> Looking for your feedback on it. Please take care and stay safe :-)
>

Thanks for looking into this. This is something it takes many eyes to kill.
:)

I'm officially home for another two weeks per work but it will almost 100%
certainly extend until the end of April.

--joel

>
> Thanks
> Mritunjay Sharma
>
>
>
>
>
>
>
>
>
> On Tue, Mar 17, 2020 at 3:57 AM Joel Sherrill <joel at rtems.org> wrote:
>
>>
>>
>> On Mon, Mar 16, 2020 at 1:35 PM Mritunjay Sharma <
>> mritunjaysharma394 at gmail.com> wrote:
>>
>>> The updated list of to be removed BSPs. Please check:
>>>
>>
>> One of us should have mentioned that there is a script at the top of the
>> RTEMS source tree
>> named "rtems-bsps which prints a report with all BSPs. Makes this a bit
>> easier.
>>
>>
>>> To be removed BSPs
>>>
>>> ARM BSPs
>>> 1) Cogent CSB637 --csb637
>>> 2) Cogent Kit637_v6 -- kit637 v6
>>>
>>
>> These two are variants of csb337
>>
>>
>>> 3) GamePark? Holdings GP2X -- gp2x
>>>
>>
>> I concur with gp32. I deleted it.
>>
>>
>>
>>>
>>>
>>> Motorola M68xxx and Coldfire BSPs
>>> 1) Generic MC68302 -- gen68302
>>>
>>
>> I concur and deleted this.
>>
>>
>>> 2) ods68302
>>>
>>
>> I concur and deleted this.
>>
>>>
>>> MIPS BSPs
>>> 1) Generic IDT 4600 -- p4000
>>> 2) Generic IDT 4650 -- p4650
>>>
>>
>> I concur and deleted these.
>>
>>>
>>> PowerPC BSPs
>>> 1) BAE RAD750 3U and 6U -- rad750
>>>
>>
>> Unfortunately, we will have to discuss this. This is a restricted
>> distribution
>> BSP that is available from NASA. This is used on a few missions.
>>
>>
>>> 2) DY-4 DMV177 -- dmv177?
>>> 3) Frasca ETHCOMM -- eth comm
>>> 4) Generic PPC405 -- gen405
>>> 5) IMD Helas 403 -- helas403?
>>>
>>
>> These I concur and addressed.
>>
>>
>>> 6) Motorola MVME2400 -- mvme2400?
>>> 7) Motorola MVME2600 -- mvme2600
>>> 8) Motorola MVME2700 -- mvme2700
>>>
>>
>> These are odd. They are supported by the motorola_powerpc BSP. One variant
>> of it supports all the mvme2xxx boards, mtx603e, and mcp750.
>>
>>>
>>> SPARC BSPs
>>> 1) SPARC Instruction Simulator (sis) -- obsoleted in 5.1.
>>>
>>
>> I thought there was more content in that page. But it is low value. I
>> deleted it.
>>
>> I also deleted the leon2 page as low value.
>>
>> On your next pass, look for BSP pages which look like very minimal
>> descriptions
>> of the board hardware with no useful information about how to use the
>> board with
>> RTEMS. :)
>>
>> --joel
>>
>>
>>>
>>> On Mon, Mar 16, 2020 at 11:31 PM Mritunjay Sharma <
>>> mritunjaysharma394 at gmail.com> wrote:
>>>
>>>> Okay, actually I looked only under
>>>> https://git.rtems.org/rtems/tree/bsps/arm/
>>>> <https://git.rtems.org/rtems/tree/bsps/arm/rtl22xx/config> (and others
>>>> like i386) and now that I know that I have to look deeper, will make a
>>>> correction and send it here.
>>>>
>>>> On Mon, Mar 16, 2020 at 11:23 PM Joel Sherrill <joel at rtems.org> wrote:
>>>>
>>>>>
>>>>>
>>>>> On Mon, Mar 16, 2020, 12:01 PM Mritunjay Sharma <
>>>>> mritunjaysharma394 at gmail.com> wrote:
>>>>>
>>>>>> Working on #3905 (Clean up BSP Wiki Pages), I have made a list of
>>>>>> BSPs that are not now part of the source tree and recommending them to
>>>>>> delete them and I would like to @rtems-devel at rtems.org
>>>>>> <devel at rtems.org> to have a look of it :
>>>>>>
>>>>>> To be removed BSPs
>>>>>>
>>>>>
>>>>> I agree with some of these but wonder how you are making the present
>>>>> or not determination. I think at least rtl22xx_t is present as a variant of
>>>>> rtl22xx. Look in it's config directory.
>>>>>
>>>>> https://git.rtems.org/rtems/tree/bsps/arm/rtl22xx/config
>>>>>
>>>>>>
>>>>>> ARM BSPs
>>>>>> 1) Cogent CSB637 --csb637
>>>>>> 2) Cogent Kit637_v6 -- kit637 v6
>>>>>> 3) RTL22xx_t (Philips/NXP ARM7 in Thumb mode) -- rtl22xx t
>>>>>> 4) GamePark? Holdings GP2X -- gp2x
>>>>>> 5) NXP LPC17XX (pin compatible to LPC24XX with ARM Cortex-M3 core) ?
>>>>>> 6) NXP LPC40XX (pin compatible to LPC24XX with ARM Cortex-M4 core) ?
>>>>>> 7) Stellaris LaunchPad? XL -- LM4F120
>>>>>> 8) STM32F105
>>>>>>
>>>>>> Motorola M68xxx and Coldfire BSPs
>>>>>> 1) Generic MC68302 -- gen68302
>>>>>> 2) Motorola MVME162LX -- mvme162lx
>>>>>> 3) ods68302
>>>>>>
>>>>>> MIPS BSPs
>>>>>> 1) Generic IDT 4600 -- p4000
>>>>>> 2) Generic IDT 4650 -- p4650
>>>>>>
>>>>>> PowerPC BSPs
>>>>>> 1) BAE RAD750 3U and 6U -- rad750
>>>>>> 2) DY-4 DMV177 -- dmv177?
>>>>>> 3) Frasca ETHCOMM -- eth comm
>>>>>> 4) Freescale MPC5554 --Phycore mpc5554?
>>>>>> 5) Freescale MPC5674FEVB -- MPC5674FEVB
>>>>>> 6) Generic PPC405 -- gen405
>>>>>> 7) IMD Helas 403 -- helas403?
>>>>>> 8) Motorola MCP750 -- mcp750
>>>>>> 9) Motorola/Phytec? Phycore MCP5554 Phycore mpc5554
>>>>>> 10)Motorola MTX603e -- mtx603e
>>>>>> 11)Motorola MVME2100 -- mvme2100
>>>>>> 12)Motorola MVME2307 -- mvme2307
>>>>>> 13)Motorola MVME2400 -- mvme2400?
>>>>>> 14)Motorola MVME2600 -- mvme2600
>>>>>> 15)Motorola MVME2700 -- mvme2700
>>>>>>
>>>>>> SPARC BSPs
>>>>>> 1) SPARC Instruction Simulator (sis) -- obsoleted in 5.1.
>>>>>>
>>>>>> Please tell if I have add to link to them also.
>>>>>>
>>>>>> Thanks
>>>>>> Mritunjay
>>>>>>
>>>>>> On Sun, Mar 15, 2020 at 10:17 PM Joel Sherrill <joel at rtems.org>
>>>>>> wrote:
>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On Sun, Mar 15, 2020 at 11:12 AM Joel Sherrill <joel at rtems.org>
>>>>>>> wrote:
>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> On Sat, Mar 14, 2020 at 10:55 PM Gedare Bloom <gedare at rtems.org>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> On Sat, Mar 14, 2020 at 2:05 PM Joel Sherrill <joel at rtems.org>
>>>>>>>>> wrote:
>>>>>>>>> >
>>>>>>>>> > I put devel@ back on
>>>>>>>>> >
>>>>>>>>> > On Sat, Mar 14, 2020, 2:23 PM Mritunjay Sharma <
>>>>>>>>> mritunjaysharma394 at gmail.com> wrote:
>>>>>>>>> >>
>>>>>>>>> >> Hi,
>>>>>>>>> >>
>>>>>>>>> >> I am very much willing to help with this thing. Being a bit new
>>>>>>>>> to the community, I just wanted to know that while deleting the wiki
>>>>>>>>> content on obsolete BSPs, do I need to report it before deleting and create
>>>>>>>>> a ticket for it or I can straightaway delete it?
>>>>>>>>> >
>>>>>>>>> >
>>>>>>>>> > I hate to start with use your judgement but...
>>>>>>>>> >
>>>>>>>>> > You could just ask on the list for deletion confirmation. My
>>>>>>>>> impression is that a deletion pass will be quick.
>>>>>>>>> >
>>>>>>>>> > For moving content to rtems-docs, that will be patches which
>>>>>>>>> need review. So post those.
>>>>>>>>> >
>>>>>>>>> > And I suspect some BSPs will have pages that are useless stubs.
>>>>>>>>> Ask about just deleting instead of converting them.
>>>>>>>>> >
>>>>>>>>> > Thanks for pitching in.
>>>>>>>>>
>>>>>>>>> I would prefer to have an analysis of the difference between what
>>>>>>>>> has
>>>>>>>>> been migrated already
>>>>>>>>> https://docs.rtems.org/branches/master/user/bsps/index.html versus
>>>>>>>>> what is in the wiki. If some content needs to move out of the wiki,
>>>>>>>>> then a patch to add it to the docs would be good, then we could
>>>>>>>>> discuss on the list whether or not to move that content or to
>>>>>>>>> delete
>>>>>>>>> it.  If content has been migrated or the migration discussion
>>>>>>>>> leads to
>>>>>>>>> a decision to delete, then we should remove that page. Removing a
>>>>>>>>> page
>>>>>>>>> requires an admin privilege, so I think a list of pages to be
>>>>>>>>> removed
>>>>>>>>> should be maintained somewhere like
>>>>>>>>> https://devel.rtems.org/wiki/TBR/BSP
>>>>>>>>
>>>>>>>>
>>>>>>>> I have made a sweep to delete all text which has links to
>>>>>>>> non-existent pages
>>>>>>>> since those do not have to be reviewed.
>>>>>>>>
>>>>>>>> My next pass is to delete all pages for BSPs and ports that have
>>>>>>>> been removed.
>>>>>>>> That is a simple review process.
>>>>>>>>
>>>>>>>
>>>>>>> I have completed this also.
>>>>>>>
>>>>>>>>
>>>>>>>> After that, what should be left is a list of pages which need
>>>>>>>> manual review to
>>>>>>>> extract/convert useful content to the Users Guide. This should be
>>>>>>>> one patch
>>>>>>>> and email per BSP/Wiki page.
>>>>>>>>
>>>>>>>
>>>>>>> This should be ready to dig into. I suspect that a number of the BSP
>>>>>>> pages are
>>>>>>> marginal having been written by Google Code-In students. If they
>>>>>>> just have
>>>>>>> hardware descriptions from vendor pages and no howtos, what do we
>>>>>>> want to do?
>>>>>>>
>>>>>>>
>>>>>>>>
>>>>>>>> I also found this list:
>>>>>>>>
>>>>>>>> https://devel.rtems.org/wiki/TBR/UserManual which has a variety of
>>>>>>>> topic
>>>>>>>> pages which need review and either deleted or merged into the
>>>>>>>> appropriate
>>>>>>>> documentation.
>>>>>>>>
>>>>>>>> --joel
>>>>>>>>
>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> >>
>>>>>>>>> >>
>>>>>>>>> >> Thanks,
>>>>>>>>> >> Mritunjay
>>>>>>>>> >>
>>>>>>>>> >> On Sat, Mar 14, 2020 at 10:30 PM Joel Sherrill <joel at rtems.org>
>>>>>>>>> wrote:
>>>>>>>>> >>>
>>>>>>>>> >>> Hi
>>>>>>>>> >>>
>>>>>>>>> >>> GSoC students and those who are unfortunately
>>>>>>>>> self-quarrantined looking for something to do could really help by
>>>>>>>>> reviewing the wiki BSP pages and helping move the current content to the
>>>>>>>>> Users Guide.
>>>>>>>>> >>>
>>>>>>>>> >>> The wiki includes an incomplete and out of date list of BSPs
>>>>>>>>> and architectures that have been removed.
>>>>>>>>> >>>
>>>>>>>>> >>> Wiki is here:
>>>>>>>>> https://devel.rtems.org/wiki/TBR/Website/Board_Support_Packages
>>>>>>>>> >>>
>>>>>>>>> >>> Users Guide is in the rtems-docs repo and viewable online at
>>>>>>>>> docs.rtems.org.
>>>>>>>>> >>>
>>>>>>>>> >>> I think much of the effort is quite straight forward. First
>>>>>>>>> pass is to delete wiki content that is on obsolete bsps and architectures.
>>>>>>>>> Delete bullets with links to no-existent pages. Introduction text on top
>>>>>>>>> page is likely useful to merge. Then remaining BSPs which are in the tree
>>>>>>>>> and have pages need the content reviewed and merged into users guide.
>>>>>>>>> >>>
>>>>>>>>> >>> --joel
>>>>>>>>> >>>
>>>>>>>>> >>>
>>>>>>>>> >>> _______________________________________________
>>>>>>>>> >>> devel mailing list
>>>>>>>>> >>> devel at rtems.org
>>>>>>>>> >>> http://lists.rtems.org/mailman/listinfo/devel
>>>>>>>>> >
>>>>>>>>> > _______________________________________________
>>>>>>>>> > devel mailing list
>>>>>>>>> > devel at rtems.org
>>>>>>>>> > http://lists.rtems.org/mailman/listinfo/devel
>>>>>>>>>
>>>>>>>>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20200330/cfc28f5d/attachment-0001.html>