blob: c907f8c9c2c0ce63d5a3e23dc77ff334b840ceff [file] [log] [blame]
Heinrich Schuchardt71820612020-04-24 23:31:20 +02001.. SPDX-License-Identifier: GPL-2.0+
2
3Develop U-Boot
4==============
5
Tom Rinia023c192022-07-14 08:07:40 -04006General
7-------
8
9.. toctree::
10 :maxdepth: 1
11
Marek Vasutb1d33702025-03-08 21:49:42 +010012 bitbangmii
Tom Rini94d6f812023-08-08 16:36:16 -040013 board_best_practices
Tom Rinia023c192022-07-14 08:07:40 -040014 codingstyle
Tom Rini491616d2022-07-14 08:07:41 -040015 designprinciples
Heinrich Schuchardt616f2122023-04-07 11:28:00 +020016 docstyle
Heinrich Schuchardt72e365b2024-11-11 10:05:39 +010017 kconfig
Simon Glass67aadc12024-09-26 14:28:51 +020018 memory
Tom Rini62a2e1d2022-08-29 12:59:33 -040019 patman
Tom Rini44769652022-07-14 08:07:43 -040020 process
Tom Rinia5e4cd62022-07-12 17:34:14 -040021 release_cycle
Tom Rini2eaffba2022-11-03 14:25:44 -040022 security
Simon Glassc8ab0312022-08-09 13:49:57 -060023 sending_patches
Tom Rini2eaffba2022-11-03 14:25:44 -040024 system_configuration
Joao Marcos Costacb1e41e2023-10-01 12:00:35 +020025 ide_integration
Tom Rinia023c192022-07-14 08:07:40 -040026
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010027Implementation
28--------------
Heinrich Schuchardt71820612020-04-24 23:31:20 +020029
30.. toctree::
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010031 :maxdepth: 1
Heinrich Schuchardt71820612020-04-24 23:31:20 +020032
Heinrich Schuchardtf5891d42023-01-25 19:15:02 +010033 directories
Simon Glass1d7e28d2021-09-08 07:33:52 -060034 bloblist
Simon Glass16047dc2024-07-17 09:30:52 +010035 bootstd/index
Tom Rinid4f5d2a2021-07-27 13:01:44 -040036 ci_testing
Heinrich Schuchardtfb952822020-12-12 08:33:28 +010037 commands
Simon Glass46236922021-09-19 15:51:10 -060038 config_binding
Stefan Roese4736bec2022-09-02 13:57:53 +020039 cyclic
Simon Glassac35c2f2021-08-01 18:57:10 -060040 devicetree/index
Simon Glass57695312021-10-14 12:48:10 -060041 distro
Simon Glassd5ea9942021-03-18 20:25:12 +130042 driver-model/index
Simon Glass420febd2021-10-21 21:08:50 -060043 environment
Simon Glass3180a7f2024-09-29 19:49:44 -060044 init
Simon Glass311bd352023-01-06 08:52:43 -060045 expo
Simon Glass40eb3c32023-08-14 16:40:29 -060046 cedit
Simon Glass0fd87062022-03-04 08:43:08 -070047 event
Heinrich Schuchardtfd574492020-10-05 08:30:10 +020048 global_data
Heinrich Schuchardt9f3d3322020-05-31 10:46:12 +020049 logging
Simon Glasse6e82442021-07-21 20:09:11 -060050 makefiles
Heinrich Schuchardt7fe2d4f2021-01-18 21:06:03 +010051 menus
Heinrich Schuchardt4f671582022-01-19 01:20:45 +010052 printf
Heinrich Schuchardtaf326e32022-02-16 07:59:31 +010053 smbios
Simon Glass7a42cd72022-04-30 00:56:45 -060054 spl
Heinrich Schuchardt4b91bc52023-07-28 22:37:40 +020055 falcon
Simon Glassdcc6b792021-03-18 20:25:11 +130056 uefi/index
Simon Glassc08a9922022-07-30 15:52:03 -060057 vbe
Simon Glass3c9b78d2021-02-04 21:17:12 -070058 version
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010059
60Debugging
61---------
62
63.. toctree::
64 :maxdepth: 1
65
66 crash_dumps
Alexander Dahle2764002024-06-26 12:47:18 +020067 gdb
Heinrich Schuchardtcc26f742020-12-12 10:14:22 +010068 trace
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010069
Simon Glass75ead662021-03-18 20:25:13 +130070Packaging
71---------
72
73.. toctree::
74 :maxdepth: 1
75
76 package/index
77
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010078Testing
79-------
80
81.. toctree::
82 :maxdepth: 1
83
Heinrich Schuchardt566a6782021-01-18 20:24:02 +010084 testing
Heinrich Schuchardt79c9f0e2021-01-18 20:24:03 +010085 py_testing
Simon Glass25404102021-03-07 17:35:17 -070086 tests_writing
Simon Glass9e78ad62021-03-07 17:34:42 -070087 tests_sandbox
Simon Glass6a0f4812024-09-30 12:51:38 -060088 binman_tests
Simon Glass9d1e6812021-07-21 21:35:50 -060089
90Refactoring
91-----------
92
93.. toctree::
94 :maxdepth: 1
95
Tom Rinia5330a12021-08-03 08:31:56 -040096 checkpatch
Simon Glass9d1e6812021-07-21 21:35:50 -060097 coccinelle
Simon Glass844a48f2023-09-23 13:44:16 -060098 qconfig
Simon Glass8724dfc2021-11-21 20:48:40 -070099
100Code quality
101------------
102
103.. toctree::
104 :maxdepth: 1
105
106 python_cq
Simon Glass4c8852b2024-08-21 10:19:26 -0600107
108Historical documentation
109------------------------
110
111.. toctree::
112 :maxdepth: 2
113
114 historical/index