blob: da9643dca1484e6a7d27c7d2da50aa5d639d78a5 [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
Tom Rini94d6f812023-08-08 16:36:16 -040012 board_best_practices
Tom Rinia023c192022-07-14 08:07:40 -040013 codingstyle
Tom Rini491616d2022-07-14 08:07:41 -040014 designprinciples
Heinrich Schuchardt616f2122023-04-07 11:28:00 +020015 docstyle
Tom Rini62a2e1d2022-08-29 12:59:33 -040016 patman
Tom Rini44769652022-07-14 08:07:43 -040017 process
Tom Rinia5e4cd62022-07-12 17:34:14 -040018 release_cycle
Tom Rini2eaffba2022-11-03 14:25:44 -040019 security
Simon Glassc8ab0312022-08-09 13:49:57 -060020 sending_patches
Tom Rini2eaffba2022-11-03 14:25:44 -040021 system_configuration
Joao Marcos Costacb1e41e2023-10-01 12:00:35 +020022 ide_integration
Tom Rinia023c192022-07-14 08:07:40 -040023
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010024Implementation
25--------------
Heinrich Schuchardt71820612020-04-24 23:31:20 +020026
27.. toctree::
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010028 :maxdepth: 1
Heinrich Schuchardt71820612020-04-24 23:31:20 +020029
Heinrich Schuchardtf5891d42023-01-25 19:15:02 +010030 directories
Simon Glass1d7e28d2021-09-08 07:33:52 -060031 bloblist
Simon Glass16047dc2024-07-17 09:30:52 +010032 bootstd/index
Tom Rinid4f5d2a2021-07-27 13:01:44 -040033 ci_testing
Heinrich Schuchardtfb952822020-12-12 08:33:28 +010034 commands
Simon Glass46236922021-09-19 15:51:10 -060035 config_binding
Stefan Roese4736bec2022-09-02 13:57:53 +020036 cyclic
Simon Glassac35c2f2021-08-01 18:57:10 -060037 devicetree/index
Simon Glass57695312021-10-14 12:48:10 -060038 distro
Simon Glassd5ea9942021-03-18 20:25:12 +130039 driver-model/index
Simon Glass420febd2021-10-21 21:08:50 -060040 environment
Simon Glass3180a7f2024-09-29 19:49:44 -060041 init
Simon Glass311bd352023-01-06 08:52:43 -060042 expo
Simon Glass40eb3c32023-08-14 16:40:29 -060043 cedit
Simon Glass0fd87062022-03-04 08:43:08 -070044 event
Heinrich Schuchardtfd574492020-10-05 08:30:10 +020045 global_data
Heinrich Schuchardt9f3d3322020-05-31 10:46:12 +020046 logging
Simon Glasse6e82442021-07-21 20:09:11 -060047 makefiles
Heinrich Schuchardt7fe2d4f2021-01-18 21:06:03 +010048 menus
Heinrich Schuchardt4f671582022-01-19 01:20:45 +010049 printf
Heinrich Schuchardtaf326e32022-02-16 07:59:31 +010050 smbios
Simon Glass7a42cd72022-04-30 00:56:45 -060051 spl
Heinrich Schuchardt4b91bc52023-07-28 22:37:40 +020052 falcon
Simon Glassdcc6b792021-03-18 20:25:11 +130053 uefi/index
Simon Glassc08a9922022-07-30 15:52:03 -060054 vbe
Simon Glass3c9b78d2021-02-04 21:17:12 -070055 version
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010056
57Debugging
58---------
59
60.. toctree::
61 :maxdepth: 1
62
63 crash_dumps
Alexander Dahle2764002024-06-26 12:47:18 +020064 gdb
Heinrich Schuchardtcc26f742020-12-12 10:14:22 +010065 trace
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010066
Simon Glass75ead662021-03-18 20:25:13 +130067Packaging
68---------
69
70.. toctree::
71 :maxdepth: 1
72
73 package/index
74
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +010075Testing
76-------
77
78.. toctree::
79 :maxdepth: 1
80
Heinrich Schuchardt566a6782021-01-18 20:24:02 +010081 testing
Heinrich Schuchardt79c9f0e2021-01-18 20:24:03 +010082 py_testing
Simon Glass25404102021-03-07 17:35:17 -070083 tests_writing
Simon Glass9e78ad62021-03-07 17:34:42 -070084 tests_sandbox
Simon Glass9d1e6812021-07-21 21:35:50 -060085
86Refactoring
87-----------
88
89.. toctree::
90 :maxdepth: 1
91
Tom Rinia5330a12021-08-03 08:31:56 -040092 checkpatch
Simon Glass9d1e6812021-07-21 21:35:50 -060093 coccinelle
Simon Glass844a48f2023-09-23 13:44:16 -060094 qconfig
Simon Glass8724dfc2021-11-21 20:48:40 -070095
96Code quality
97------------
98
99.. toctree::
100 :maxdepth: 1
101
102 python_cq
Simon Glass4c8852b2024-08-21 10:19:26 -0600103
104Historical documentation
105------------------------
106
107.. toctree::
108 :maxdepth: 2
109
110 historical/index