Debian Codegraph @

cmake/tribits/doc/guides/maintainers_guide/TribitsMaintainersGuide.rst

raw
1 =======================================
2 TriBITS Maintainers Guide and Reference
3 =======================================
4
5 :Author: Roscoe A. Bartlett ([email protected])
6 :Date: |date|
7 :Version: .. include:: ../TribitsGitVersion.txt
8
9 .. |date| date::
10
11 :Abstract: This document describes the internal implementation and the maintenance of the TriBITS project itself. The primary audience are those individuals who will make changes and contributions to the TriBITS project or just want to understand its implementation details. Included is all of the same information as the TriBITS Users Guide but also include file names and line numbers for all of the documented TriBITS macros and functions.
12
13 .. sectnum::
14 :depth: 2
15
16 .. Above, the depth of the TOC is set to just 2 because I don't want the
17 .. TriBITS function/macro names to have section numbers appearing before them.
18 .. Also, some of them are long and I don't want them to go off the page of the
19 .. PDF document.
20
21 .. Sections in this document use the underlines:
22 ..
23 .. Level-1 ==================
24 .. Level-2 ------------------
25 .. Level-3 ++++++++++++++++++
26 .. Level-4 ..................
27
28 .. contents::
29
30
31 Introduction
32 =============
33
34 This document describes the usage and maintenance of the TriBITS (Tribal
35 Build, Integration, Test System) package itself. This document includes a
36 super-set the material from the `TriBITS Users Guide and Reference`_ document.
37 In addition, all of the detailed function and macro documentation blocks
38 include the file names and line numbers where they are implemented in the
39 TriBITS source repository. This makes it easier to navigate around the TriBITS
40 source code when developing on TriBITS itself or just trying to understand its
41 implementation.
42
43
44 .. include:: ../TribitsGuidesBody.rst
45
46
47 .. include:: TribitsCoreDetailedReference.rst
48
49
50 TriBITS System Maintainers Documentation
51 ========================================
52
53 This section contains more detailed information about the internal
54 implementation of TriBITS. This information is meant to make it easier to
55 understand and manipulate the data-structures and macros/functions that make
56 up internal implementation of TriBITS and is important for `TriBITS System
57 Developers`_ and `TriBITS System Architects`_.
58
59 .. include:: ../../../core/package_arch/TribitsSystemDataStructuresMacrosFunctions.rst
60
61
62 .. include:: TribitsSystemMacroFunctionDoc.rst
63
64
65 .. include:: ../TribitsGuidesReferences.rst
66
67
68 .. include:: ../TribitsFAQ.rst
69
70
71 Appendix
72 ========
73
74 .. include:: ../TribitsCMakeLanguageOverviewAndGotchas.rst
75
76 .. include:: ../TribitsHistory.rst
77
78 .. include:: ../TribitsPackageNotCMakePackage.rst
79
80 .. include:: ../TribitsDesignConsiderations.rst
81
82 .. include:: ../TribitsToolsDocumentation.rst