[RTEMS Project] #2618: Each Directive Should Start on a Page

[RTEMS trac]

#2618: Each Directive Should Start on a Page
---------------------------+--------------------
 Reporter:  joel.sherrill  |      Owner:  chrisj
     Type:  defect         |     Status:  new
 Priority:  normal         |  Milestone:  4.11
Component:  General        |    Version:  4.11
 Severity:  normal         |   Keywords:
---------------------------+--------------------
 The current documentation ensures that each directive/service "man page"
 starts on a new page. This is in keeping with traditional UNIX
 documentation. This avoids having a page break early in the description of
 the method. The prototype, error codes, and at least part of the
 description will then always be on the same page without breaks.

 In texinfo, the concept of a "new page" is ignored on non-printed output
 formats such as html and info. It only applies for PDF and PS.

 The new documentation needs to follow the same pattern.

 If you do not force a page break, then at least the headings "CALLING
 SEQUENCE", etc need to be tagged as staying with the next paragraph. Then
 at least the x.y.x HEADING, CALLING SEQUENCE, and prototype would be on
 the same page.

--
Ticket URL: <http://devel.rtems.org/ticket/2618>
RTEMS Project <http://www.rtems.org/>
RTEMS Project