Gitiles
Code Review Sign In
git01.mediatek.com / filogic / uboot / 7bbd3bb66a7a1b60fe4078a2b92c0b9ca4ee3f37 / . / doc / develop / index.rst
blob: d9f2a8382077f35dfc4b688a2678f9cc496a748e [file] [log] [blame]
Heinrich Schuchardt71820612020-04-24 23:31:20 +0200[diff] [blame]1.. SPDX-License-Identifier: GPL-2.0+
2
3Develop U-Boot
4==============
5
Tom Rinia023c192022-07-14 08:07:40 -0400[diff] [blame]6General
7-------
8
9.. toctree::
10 :maxdepth: 1
11
Tom Rini94d6f812023-08-08 16:36:16 -0400[diff] [blame]12 board_best_practices
Tom Rinia023c192022-07-14 08:07:40 -0400[diff] [blame]13 codingstyle
Tom Rini491616d2022-07-14 08:07:41 -0400[diff] [blame]14 designprinciples
Heinrich Schuchardt616f2122023-04-07 11:28:00 +0200[diff] [blame]15 docstyle
Heinrich Schuchardt72e365b2024-11-11 10:05:39 +0100[diff] [blame]16 kconfig
Simon Glass67aadc12024-09-26 14:28:51 +0200[diff] [blame]17 memory
Tom Rini62a2e1d2022-08-29 12:59:33 -0400[diff] [blame]18 patman
Tom Rini44769652022-07-14 08:07:43 -0400[diff] [blame]19 process
Tom Rinia5e4cd62022-07-12 17:34:14 -0400[diff] [blame]20 release_cycle
Tom Rini2eaffba2022-11-03 14:25:44 -0400[diff] [blame]21 security
Simon Glassc8ab0312022-08-09 13:49:57 -0600[diff] [blame]22 sending_patches
Tom Rini2eaffba2022-11-03 14:25:44 -0400[diff] [blame]23 system_configuration
Joao Marcos Costacb1e41e2023-10-01 12:00:35 +0200[diff] [blame]24 ide_integration
Tom Rinia023c192022-07-14 08:07:40 -0400[diff] [blame]25
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +0100[diff] [blame]26Implementation
27--------------
Heinrich Schuchardt71820612020-04-24 23:31:20 +0200[diff] [blame]28
29.. toctree::
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +0100[diff] [blame]30 :maxdepth: 1
Heinrich Schuchardt71820612020-04-24 23:31:20 +0200[diff] [blame]31
Heinrich Schuchardtf5891d42023-01-25 19:15:02 +0100[diff] [blame]32 directories
Simon Glass1d7e28d2021-09-08 07:33:52 -0600[diff] [blame]33 bloblist
Simon Glass16047dc2024-07-17 09:30:52 +0100[diff] [blame]34 bootstd/index
Tom Rinid4f5d2a2021-07-27 13:01:44 -0400[diff] [blame]35 ci_testing
Heinrich Schuchardtfb952822020-12-12 08:33:28 +0100[diff] [blame]36 commands
Simon Glass46236922021-09-19 15:51:10 -0600[diff] [blame]37 config_binding
Stefan Roese4736bec2022-09-02 13:57:53 +0200[diff] [blame]38 cyclic
Simon Glassac35c2f2021-08-01 18:57:10 -0600[diff] [blame]39 devicetree/index
Simon Glass57695312021-10-14 12:48:10 -0600[diff] [blame]40 distro
Simon Glassd5ea9942021-03-18 20:25:12 +1300[diff] [blame]41 driver-model/index
Simon Glass420febd2021-10-21 21:08:50 -0600[diff] [blame]42 environment
Simon Glass3180a7f2024-09-29 19:49:44 -0600[diff] [blame]43 init
Simon Glass311bd352023-01-06 08:52:43 -0600[diff] [blame]44 expo
Simon Glass40eb3c32023-08-14 16:40:29 -0600[diff] [blame]45 cedit
Simon Glass0fd87062022-03-04 08:43:08 -0700[diff] [blame]46 event
Heinrich Schuchardtfd574492020-10-05 08:30:10 +0200[diff] [blame]47 global_data
Heinrich Schuchardt9f3d3322020-05-31 10:46:12 +0200[diff] [blame]48 logging
Simon Glasse6e82442021-07-21 20:09:11 -0600[diff] [blame]49 makefiles
Heinrich Schuchardt7fe2d4f2021-01-18 21:06:03 +0100[diff] [blame]50 menus
Heinrich Schuchardt4f671582022-01-19 01:20:45 +0100[diff] [blame]51 printf
Heinrich Schuchardtaf326e32022-02-16 07:59:31 +0100[diff] [blame]52 smbios
Simon Glass7a42cd72022-04-30 00:56:45 -0600[diff] [blame]53 spl
Heinrich Schuchardt4b91bc52023-07-28 22:37:40 +0200[diff] [blame]54 falcon
Simon Glassdcc6b792021-03-18 20:25:11 +1300[diff] [blame]55 uefi/index
Simon Glassc08a9922022-07-30 15:52:03 -0600[diff] [blame]56 vbe
Simon Glass3c9b78d2021-02-04 21:17:12 -0700[diff] [blame]57 version
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +0100[diff] [blame]58
59Debugging
60---------
61
62.. toctree::
63 :maxdepth: 1
64
65 crash_dumps
Alexander Dahle2764002024-06-26 12:47:18 +0200[diff] [blame]66 gdb
Heinrich Schuchardtcc26f742020-12-12 10:14:22 +0100[diff] [blame]67 trace
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +0100[diff] [blame]68
Simon Glass75ead662021-03-18 20:25:13 +1300[diff] [blame]69Packaging
70---------
71
72.. toctree::
73 :maxdepth: 1
74
75 package/index
76
Heinrich Schuchardtac1627b2021-01-18 20:24:01 +0100[diff] [blame]77Testing
78-------
79
80.. toctree::
81 :maxdepth: 1
82
Heinrich Schuchardt566a6782021-01-18 20:24:02 +0100[diff] [blame]83 testing
Heinrich Schuchardt79c9f0e2021-01-18 20:24:03 +0100[diff] [blame]84 py_testing
Simon Glass25404102021-03-07 17:35:17 -0700[diff] [blame]85 tests_writing
Simon Glass9e78ad62021-03-07 17:34:42 -0700[diff] [blame]86 tests_sandbox
Simon Glass6a0f4812024-09-30 12:51:38 -0600[diff] [blame]87 binman_tests
Simon Glass9d1e6812021-07-21 21:35:50 -0600[diff] [blame]88
89Refactoring
90-----------
91
92.. toctree::
93 :maxdepth: 1
94
Tom Rinia5330a12021-08-03 08:31:56 -0400[diff] [blame]95 checkpatch
Simon Glass9d1e6812021-07-21 21:35:50 -0600[diff] [blame]96 coccinelle
Simon Glass844a48f2023-09-23 13:44:16 -0600[diff] [blame]97 qconfig
Simon Glass8724dfc2021-11-21 20:48:40 -0700[diff] [blame]98
99Code quality
100------------
101
102.. toctree::
103 :maxdepth: 1
104
105 python_cq
Simon Glass4c8852b2024-08-21 10:19:26 -0600[diff] [blame]106
107Historical documentation
108------------------------
109
110.. toctree::
111 :maxdepth: 2
112
113 historical/index