Changes between Version 4 and Version 5 of Developer/Coding/Doxygen_for_BSPs


Ignore:
Timestamp:
Oct 23, 2018, 3:58:12 PM (6 months ago)
Author:
Vijay Kumar Banerjee
Comment:

fixing libbsp reference

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen_for_BSPs

    v4 v5  
    4040= The Structure of the libbsp directory =
    4141
    42 All BSPs are found within the c/src/lib/libbsp directory, which is itself very well ordered. At the first level, we find a directory for each CPU architecture RTEMS supports, as well as a directory for code shared by all implementations.
    43 
    44 {{{
    45 $ cd c/src/lib/libbsp
     42All BSPs are found within the bsps/ directory, which is itself very well ordered. At the first level, we find a directory for each CPU architecture RTEMS supports, as well as a directory for code shared by all implementations.
     43
     44{{{
     45$ cd bsps
    4646$ ls
    4747arm   bsp.am  lm32  m68k             mips   no_cpu         README  sparc
     
    7474{{{
    7575$ pwd
    76 ~/rtems/c/src/lib/libbsp/arm/raspberrypi
     76~/rtems/bsps/arm/raspberrypi
    7777$ tree -f
    7878.
     
    109109
    110110In short, BSPs will use the following directories:
    111  *  c/src/lib/libbsp/'''''shared'''''                        <- code used that is shared by all BSPs
    112  *  c/src/lib/libbsp/'''''CPU'''''/'''''shared'''''          <- code used shared by all BSPs of a particular CPU architecture
    113  *  c/src/lib/libbsp/'''''CPU'''''/'''''BSP'''''             <- code unique to this BSP
     111 *  bsps/'''''shared'''''                        <- code used that is shared by all BSPs
     112 *  bsps/'''''CPU'''''/'''''shared'''''          <- code used shared by all BSPs of a particular CPU architecture
     113 *  bsps/'''''CPU'''''/'''''BSP'''''             <- code unique to this BSP
    114114
    115115As you can see, libbsp has a very logical and easy to understand structure to it. The documentation generated by Doxygen should attempt to match this structure as closely as possible. We want an overarching parent group to serve the same purpose as the libbsp directory. In it, we want groups for each CPU architecture and a group for the shared files. We then want groups for each BSP. Breaking our documentation up into discrete groups like this will greatly simplify the process and make the documentation much easier to go through. By learning about the existing structure of the libbsp directory, we get an idea of how we should structure the Doxygen groups we create. More on this in the next section.
     
    231231{{{
    232232export r=~/rtems
    233 ./do_doxygen c/src/lib/libbsp
     233./do_doxygen bsps
    234234}}}
    235235