BSP Wiki Clean Up

Mon Mar 16 18:01:51 UTC 2020

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/20200316/c80e0f49/attachment-0001.html>