u-boot.git/doc/develop/index.rst, branch v2024.10

doc: Move bootstd into its own directory

2024-07-19T11:53:05+00:00

Before adding more files, move the bootstd docs into a new directory,
with an index.

Signed-off-by: Simon Glass 
Reviewed-by: Quentin Schulz 
Reviewed-by: Mattijs Korpershoek

doc: develop: Add a general section on gdb usage

2024-06-30T11:58:31+00:00

Mashed up from different sources linked below, including the now gone
Wiki and doc/README.arm-relocation file.  Tested on a custom board with
AT91 SAMA5D2 SoC and Segger J-Link Base adapter.  This is only generic
advice here, the usage is not board specific.  Some board docs have more
specific instructions on using gdb with a particular board.

Link: https://www.slideshare.net/slideshow/embedded-recipes-2019-introduction-to-jtag-debugging/177511981
Link: https://boundarydevices.com/debugging-using-segger-j-link-jtag/
Link: https://web.archive.org/web/20141224200032/http://www.denx.de/wiki/view/DULG/DebuggingUBoot
Link: https://web.archive.org/web/20141206064148/http://www.denx.de/wiki/view/DULG/GDBScripts1
Suggested-by: Marek Vasut 
Signed-off-by: Alexander Dahl 
Reviewed-by: Heinrich Schuchardt

doc: add ide_integration.rst to doc/develop

2023-10-11T17:24:55+00:00

Add 'Integration with IDEs' chapter.

For now, this chapter is mostly a reference to the documentation of
gen_compile_commands, in doc/build, but it can be futurely used as
a guide for other IDE-friendly features.

Signed-off-by: Joao Marcos Costa 
Tested-by: Joao Paulo Goncalves

qconfig: Update the documentation

2023-10-04T15:25:22+00:00

Update qconfig's documentation to better reflect its new purpose in life.

Signed-off-by: Simon Glass

expo: Add documentation for the configuration editor

2023-08-25T17:54:33+00:00

This is mentioned in passing in the 'cedit' command. Its file format is
described under `expo`. But it would be better if it had its own entry
in the documentation.

Add a new 'cedit' entry with a few details about this feature.

Signed-off-by: Simon Glass

doc: Begin adding a best practices document for board ports

2023-08-09T06:41:52+00:00

To help guide developers down the right path, begin a document that
lists some best practices to follow when creating a new board port.

Signed-off-by: Tom Rini 
Reviewed-by: Simon Glass

doc: move README.falcon to HTML

2023-08-03T07:21:02+00:00

Move the Falcon mode documentation to HTML.

Signed-off-by: Heinrich Schuchardt

doc: describe our documentation style

2023-04-08T05:44:33+00:00

Provide a reference document for the U-Boot documentation style.

Signed-off-by: Heinrich Schuchardt 
Reviewed-by: Tom Rini 
Reviewed-by: Simon Glass

doc: move directory hierarchy to HTML

2023-01-27T17:32:00+00:00

Move section 'Directory hierarchy' from file README to the HTML
documentation.

Signed-off-by: Heinrich Schuchardt 
Reviewed-by: Tom Rini 
Reviewed-by: Simon Glass

expo: Add documentation

2023-01-16T23:26:51+00:00

Add some documentation for the expo feature.

Signed-off-by: Simon Glass