mirror of
https://source.denx.de/u-boot/u-boot.git
synced 2026-06-02 09:46:37 +03:00
0290cec364
Add a contributors file to provide a high level overview for people who wish to contribute to the project outlining basic details and setting some project expectations. This isn't intended to replace any of the existing documentation but rather provide a succinct top level document that's easy to find to enable users to understand the project and get started as quickly as possible. Signed-off-by: Peter Robinson <pbrobinson@gmail.com> [trini: Correct merge window length, release day and typo in the main index] Signed-off-by: Tom Rini <trini@konsulko.com>
116 lines
2.3 KiB
ReStructuredText
116 lines
2.3 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0+
|
|
|
|
.. _u-boot_doc:
|
|
|
|
The U-Boot Documentation
|
|
========================
|
|
|
|
This is the top level of the U-Boot's documentation tree. U-Boot
|
|
documentation, like the U-Boot itself, is very much a work in progress;
|
|
that is especially true as we work to integrate our many scattered
|
|
documents into a coherent whole. Please note that improvements to the
|
|
documentation are welcome; join the U-Boot list at http://lists.denx.de
|
|
if you want to help out.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Contributing Guidelines
|
|
-----------------------
|
|
|
|
General guidelines for contributing to the U-Boot project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
CONTRIBUTE
|
|
|
|
User-oriented documentation
|
|
---------------------------
|
|
|
|
The following manuals are written for *users* of the U-Boot - those who are
|
|
trying to get it to work optimally on a given system.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
build/index
|
|
learn/index
|
|
usage/index
|
|
|
|
Developer-oriented documentation
|
|
--------------------------------
|
|
|
|
The following manuals are written for *developers* of the U-Boot - those who
|
|
want to contribute to U-Boot.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
develop/index
|
|
|
|
|
|
U-Boot API documentation
|
|
------------------------
|
|
|
|
These books get into the details of how specific U-Boot subsystems work
|
|
from the point of view of a U-Boot developer. Much of the information here
|
|
is taken directly from the U-Boot source, with supplemental material added
|
|
as needed (or at least as we managed to add it - probably *not* all that is
|
|
needed).
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api/index
|
|
|
|
Architecture-specific doc
|
|
-------------------------
|
|
|
|
These books provide programming details about architecture-specific
|
|
implementation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
arch/index
|
|
|
|
Board-specific doc
|
|
------------------
|
|
|
|
These books provide details about board-specific information. They are
|
|
organized in a vendor subdirectory.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
board/index
|
|
|
|
Android-specific doc
|
|
--------------------
|
|
|
|
These books provide information about booting the Android OS from U-Boot,
|
|
manipulating Android images from U-Boot shell and discusses other
|
|
Android-specific features available in U-Boot.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
android/index
|
|
|
|
Chromium OS-specific doc
|
|
------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
chromium/index
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
genindex
|