u-boot.git/doc/develop/index.rst, branch v2021.10-rc2Unnamed repository; edit this file 'description' to name the repository.http://cgit.235523.xyz/u-boot.git/atom/doc/develop/index.rst?h=v2021.10-rc22021-08-14T18:54:41Zdoc: Move devicetree control doc to rST2021-08-14T18:54:41ZSimon Glasssjg@chromium.org2021-08-02T00:57:10Zurn:sha1:3e9fddfc4f146f3a64c935024f5e1918790d2777
Move this to rST format, largely unchanged to start with. Add an index
for this topic, as well as an empty intro.
Note this patch does not include updates! Is it just a conversion to the
new format. See the next patch.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Heinrich Schuchart <xypron.glpk@gmx.de>
doc: Add basic information about running CI tests2021-08-04T19:58:31ZTom Rinitrini@konsulko.com2021-07-27T17:01:44Zurn:sha1:08e8bc8a7fd253a45ed97b46afc4046809bfda22
Start out by documenting general expectations on when CI is run, how
anyone can run Azure pipelines, and how GitLab CI pipelines can be run.
Signed-off-by: Tom Rini <trini@konsulko.com>
doc: Add docs for the moveconfig tool2021-08-01T15:05:24ZSimon Glasssjg@chromium.org2021-07-22T03:35:51Zurn:sha1:5c72c0e0d2bb5ff8aa38b4cebdb4e1d4dd311b5d
Move these docs into htmldocs so they can be read there.
Signed-off-by: Simon Glass <sjg@chromium.org>
doc: Move coccinelle into its own section2021-08-01T15:05:24ZSimon Glasssjg@chromium.org2021-07-22T03:35:50Zurn:sha1:a980e7bbde5becf014a8cda7dd0c6fe9c1b234d9
This tool has nothing to do with testing. It is for refactoring code
automatically using a 'semantic patch' tool.
Create a new section for 'refactoring' and move it into there. It is
likely that other topics may fall under the same heading, such as
using moveconfig and search/replace tools.
Signed-off-by: Simon Glass <sjg@chromium.org>
doc: Create an intro section for testing2021-08-01T15:05:24ZSimon Glasssjg@chromium.org2021-07-22T03:35:49Zurn:sha1:2d754cea4c18f0200ff14c038fe4d3f206b684d9
At present this information is hidden away. Make it more visible by
putting it first, in an intro section.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc: Bring in Makefile documentation2021-07-24T08:49:51ZSimon Glasssjg@chromium.org2021-07-22T02:09:11Zurn:sha1:00ac4b414fe9187aaa69e2e386879b574ae34991
U-Boot uses the Linux Kbuild build system. Add the associated
documentation so that people can understand the Makefiles better.
This is taken from Linux v5.12
Signed-off-by: Simon Glass <sjg@chromium.org>
binman: doc: Add documentation to htmldocs2021-03-26T04:03:10ZSimon Glasssjg@chromium.org2021-03-18T07:25:13Zurn:sha1:61adb2d2474eb72ea05365ef81e5c6d7e5f61441
Add a link to binman's documentation and adjust the files so that it is
accessible. Use the name README.rst so it is easy to discover when binman
is installed without U-Boot.
Signed-off-by: Simon Glass <sjg@chromium.org>
doc: Move driver model docs under develop/2021-03-26T04:03:10ZSimon Glasssjg@chromium.org2021-03-18T07:25:12Zurn:sha1:5ce319133b2364e3283c3cde7a269681ff8431af
These docs are useful for developers, not users. Move them under that
section.
Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Signed-off-by: Simon Glass <sjg@chromium.org>
doc: Move UEFI under develop/2021-03-26T04:03:10ZSimon Glasssjg@chromium.org2021-03-18T07:25:11Zurn:sha1:d1ceeeff6c2ee1e55b7140654c8d6de44b60dab6
Much of the content here is useful only for development. Move it under
that section.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc: Explain briefly how to write new tests2021-03-12T14:57:31ZSimon Glasssjg@chromium.org2021-03-08T00:35:17Zurn:sha1:fc3283314539d6c3fb577359f6cb364c19c13726
Add a second on writing tests, covering when to use Python and C, where
to put the tests, etc. Add a link to the existing Python test
documentation.
Signed-off-by: Simon Glass <sjg@chromium.org>