Gitiles
Code Review Sign In
gerrit.devboardsforandroid.linaro.org / platform / external / u-boot / 5e9b16ebca7e2e7902c0da0347777d1e268c7363 / . / doc / develop / index.rst
blob: 30f7fdb8847f4fd0059bf9636b3e83e39df49388 [file] [log] [blame]
Heinrich Schuchardt932b8f82020-04-24 23:31:20 +0200[diff] [blame]1.. SPDX-License-Identifier: GPL-2.0+
2
3Develop U-Boot
4==============
5
Tom Rini4211fb22022-07-14 08:07:40 -0400[diff] [blame]6General
7-------
8
9.. toctree::
10 :maxdepth: 1
11
Tom Rinifa437092023-08-08 16:36:16 -0400[diff] [blame]12 board_best_practices
Tom Rini4211fb22022-07-14 08:07:40 -0400[diff] [blame]13 codingstyle
Tom Rini528581e2022-07-14 08:07:41 -0400[diff] [blame]14 designprinciples
Heinrich Schuchardt624faee2023-04-07 11:28:00 +0200[diff] [blame]15 docstyle
Simon Glass77a93ae2024-09-26 14:28:51 +0200[diff] [blame]16 memory
Tom Rini6349b182022-08-29 12:59:33 -0400[diff] [blame]17 patman
Tom Rinidc1ad472022-07-14 08:07:43 -0400[diff] [blame]18 process
Tom Rini6b484ba2022-07-12 17:34:14 -0400[diff] [blame]19 release_cycle
Tom Rini541e68d2022-11-03 14:25:44 -0400[diff] [blame]20 security
Simon Glass37c42b72022-08-09 13:49:57 -0600[diff] [blame]21 sending_patches
Tom Rini541e68d2022-11-03 14:25:44 -0400[diff] [blame]22 system_configuration
Joao Marcos Costa33717db2023-10-01 12:00:35 +0200[diff] [blame]23 ide_integration
Tom Rini4211fb22022-07-14 08:07:40 -0400[diff] [blame]24
Heinrich Schuchardt948991f2021-01-18 20:24:01 +0100[diff] [blame]25Implementation
26--------------
Heinrich Schuchardt932b8f82020-04-24 23:31:20 +0200[diff] [blame]27
28.. toctree::
Heinrich Schuchardt948991f2021-01-18 20:24:01 +0100[diff] [blame]29 :maxdepth: 1
Heinrich Schuchardt932b8f82020-04-24 23:31:20 +0200[diff] [blame]30
Heinrich Schuchardtc85ee982023-01-25 19:15:02 +0100[diff] [blame]31 directories
Simon Glass4d7bb452021-09-08 07:33:52 -0600[diff] [blame]32 bloblist
Simon Glassc684db92024-07-17 09:30:52 +0100[diff] [blame]33 bootstd/index
Tom Rini08e8bc82021-07-27 13:01:44 -0400[diff] [blame]34 ci_testing
Heinrich Schuchardt380c6b92020-12-12 08:33:28 +0100[diff] [blame]35 commands
Simon Glass269d2d12021-09-19 15:51:10 -0600[diff] [blame]36 config_binding
Stefan Roese00275f52022-09-02 13:57:53 +0200[diff] [blame]37 cyclic
Simon Glass3e9fddf2021-08-01 18:57:10 -0600[diff] [blame]38 devicetree/index
Simon Glass37c51952021-10-14 12:48:10 -0600[diff] [blame]39 distro
Simon Glass5ce31912021-03-18 20:25:12 +1300[diff] [blame]40 driver-model/index
Simon Glass40b9e0d2021-10-21 21:08:50 -0600[diff] [blame]41 environment
Simon Glass64746bf2024-09-29 19:49:44 -0600[diff] [blame]42 init
Simon Glassb5c8fea2023-01-06 08:52:43 -0600[diff] [blame]43 expo
Simon Glassc5aacf52023-08-14 16:40:29 -0600[diff] [blame]44 cedit
Simon Glassabe5d112022-03-04 08:43:08 -0700[diff] [blame]45 event
Heinrich Schuchardt467d90a2020-10-05 08:30:10 +0200[diff] [blame]46 global_data
Heinrich Schuchardta7813912020-05-31 10:46:12 +0200[diff] [blame]47 logging
Simon Glass00ac4b42021-07-21 20:09:11 -0600[diff] [blame]48 makefiles
Heinrich Schuchardt12316962021-01-18 21:06:03 +0100[diff] [blame]49 menus
Heinrich Schuchardtf5e90352022-01-19 01:20:45 +0100[diff] [blame]50 printf
Heinrich Schuchardt5e044352022-02-16 07:59:31 +0100[diff] [blame]51 smbios
Simon Glassd4113592022-04-30 00:56:45 -0600[diff] [blame]52 spl
Heinrich Schuchardt7fe39012023-07-28 22:37:40 +0200[diff] [blame]53 falcon
Simon Glassd1ceeef2021-03-18 20:25:11 +1300[diff] [blame]54 uefi/index
Simon Glass915458e2022-07-30 15:52:03 -0600[diff] [blame]55 vbe
Simon Glass9b95f3f2021-02-04 21:17:12 -0700[diff] [blame]56 version
Heinrich Schuchardt948991f2021-01-18 20:24:01 +0100[diff] [blame]57
58Debugging
59---------
60
61.. toctree::
62 :maxdepth: 1
63
64 crash_dumps
Alexander Dahl636480e2024-06-26 12:47:18 +0200[diff] [blame]65 gdb
Heinrich Schuchardtdce26c72020-12-12 10:14:22 +0100[diff] [blame]66 trace
Heinrich Schuchardt948991f2021-01-18 20:24:01 +0100[diff] [blame]67
Simon Glass61adb2d2021-03-18 20:25:13 +1300[diff] [blame]68Packaging
69---------
70
71.. toctree::
72 :maxdepth: 1
73
74 package/index
75
Heinrich Schuchardt948991f2021-01-18 20:24:01 +0100[diff] [blame]76Testing
77-------
78
79.. toctree::
80 :maxdepth: 1
81
Heinrich Schuchardtca6583d2021-01-18 20:24:02 +0100[diff] [blame]82 testing
Heinrich Schuchardt01576192021-01-18 20:24:03 +0100[diff] [blame]83 py_testing
Simon Glassfc328332021-03-07 17:35:17 -0700[diff] [blame]84 tests_writing
Simon Glass4c8850a2021-03-07 17:34:42 -0700[diff] [blame]85 tests_sandbox
Simon Glass7f4e1ea2024-09-30 12:51:38 -0600[diff] [blame]86 binman_tests
Simon Glassa980e7b2021-07-21 21:35:50 -0600[diff] [blame]87
88Refactoring
89-----------
90
91.. toctree::
92 :maxdepth: 1
93
Tom Rinie199fb32021-08-03 08:31:56 -0400[diff] [blame]94 checkpatch
Simon Glassa980e7b2021-07-21 21:35:50 -0600[diff] [blame]95 coccinelle
Simon Glass4840b712023-09-23 13:44:16 -0600[diff] [blame]96 qconfig
Simon Glassfeafc612021-11-21 20:48:40 -0700[diff] [blame]97
98Code quality
99------------
100
101.. toctree::
102 :maxdepth: 1
103
104 python_cq
Simon Glass09c58e02024-08-21 10:19:26 -0600[diff] [blame]105
106Historical documentation
107------------------------
108
109.. toctree::
110 :maxdepth: 2
111
112 historical/index