[RTEMS Project] #2854: What to do with the README files in the RTEMS sources?

[RTEMS trac]

#2854: What to do with the README files in the RTEMS sources?
-----------------------------+-------------------
 Reporter:  sebastian.huber  |       Owner:
     Type:  enhancement      |      Status:  new
 Priority:  normal           |   Milestone:  5.0
Component:  Documentation    |     Version:  4.12
 Severity:  normal           |  Resolution:
 Keywords:                   |
-----------------------------+-------------------

Comment (by chrisj):

 I think grouping all READMEs together does not work, it forces a lowest
 common denominator. We should consider each type separately. I see:

 1. BSP
 2. Testsuite
 3. 3rd Party packages
 4. RTEMS kernel, ie the top level, c/src etc.

 == BSP ==

 I think important information about a BSP needs to captured in `rtems-
 docs.git`. The documentation on a BSP forms an interface a user of the BSP
 can rely on and we need to make sure it is stable across releases. We also
 need to make changes clear to uses with specifics on how to migrate.

 The wiki can contain transient and less formal documentation, for example
 how to use a specific debugger.

 == Testsuite ==

 I do not know about these.

 == 3rd Party packages ==

 If a copy of the original package, leave.

 == RTEMS kernel ==

 No idea. I suspect they will not be needed in a waf build system.

 == Wiki ==

 '''TRB''' in the wiki means "To Be Reviewed" or "To Be Removed" depending
 on how you want to look at the pages. I feel the wiki needs be cleaned up,
 containing only relevant pages to be seriously considered a suitable place
 to add important documentation. Adding to the current pages means you need
 to know the history and importance to know how valid the pages are.

--
Ticket URL: <http://devel.rtems.org/ticket/2854#comment:1>
RTEMS Project <http://www.rtems.org/>
RTEMS Project