[PATCH 1/2] bsps: Adjust architecture Doxygen groups
chrisj at rtems.org
Wed Feb 27 21:57:16 UTC 2019
On 28/2/19 6:37 am, Sebastian Huber wrote:
> ----- Am 27. Feb 2019 um 15:56 schrieb joel joel at rtems.org:
>> What's the rationale for changing the group names and is this described in
>> the software engineering guide?
> We will add each of the about 5000 code files to at least one group, so this requires some common pattern. Use of CamelCase makes it easier to search and replace (we don't use CamelCase in C). The "RTEMS" prefix makes it possible to integrate the RTEMS files in a larger project if desired. Using PackageSubPackageSubSubPackageEtc makes the group names unique and easy to search by scope, e.g. "PackageSubPackage", "PackageSubPackage\>".
Could the commit message be updated with a summary of this? Providing localised
pieces of info means users do not need a complete map of everything in RTEMS to
make sense of something.
- Use CamelCase as it is not used in our C code. A simpler search and replace.
- Prefix with `RTEMS` to aid deployment and integration. It aids searching and
Note, this last point should be a general item in the eng guide. RTEMS has to
consider itself as a sub-part of something bigger so namespace tagging is very
important in everything we do.
More information about the devel