summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2023-04-09 11:08:39 -0400
committerTom Rini <trini@konsulko.com>2023-04-09 11:08:39 -0400
commit7daa8dd59bc8455a43cdd2d0e34206e406e5cdcc (patch)
tree975875173c54134724ee81a05773d69795c3e924 /doc/develop
parentfa6f458c679f55edd11e8e34f209d4a0e01bf7bc (diff)
parentd9d07d751e0f41d009051e8c25e2d5d9cf7ca41c (diff)
Merge tag 'efi-2023-07-rc1' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for efi-2023-07-rc1 Documentation: * man-page for coninfo command * documentation style * switch settings for boot modes on AM62 SK UEFI: * avoid using deprecated HandleProtocol() * set static attribute for non-exported functions and variables
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/docstyle.rst29
-rw-r--r--doc/develop/index.rst1
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/develop/docstyle.rst b/doc/develop/docstyle.rst
new file mode 100644
index 00000000000..f9ba83a559c
--- /dev/null
+++ b/doc/develop/docstyle.rst
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Documentation Style
+===================
+
+Documentation is crucial for the U-Boot project. It has to encompass the needs
+of different reader groups from first time users to developers and maintainers.
+This requires different types of documentation like tutorials, how-to-guides,
+explanatory texts, and reference.
+
+We want to be able to generate documentation in different target formats. We
+therefore use `Sphinx <https://www.sphinx-doc.org>`_ for the generation of
+documents from reStructured text.
+
+We apply the following rules:
+
+* Documentation files are located in *doc/* or its sub-directories.
+* Each documentation file is added to an index page to allow navigation
+ to the document.
+* For documentation we use reStructured text conforming to the requirements
+ of `Sphinx <https://www.sphinx-doc.org>`_.
+* For documentation within code we follow the Linux kernel guide
+ `Writing kernel-doc comments <https://docs.kernel.org/doc-guide/kernel-doc.html>`_.
+* We try to stick to 80 columns per line in documents.
+* For tables we prefer simple tables over grid tables. We avoid list tables
+ as they make the reStructured text documents hard to read.
+* Before submitting documentation patches we build the HTML documentation and
+ fix all warnings. The build process is described in
+ :doc:`/build/documentation`.
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index a52ad630d0d..ddbf8dad4a1 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -11,6 +11,7 @@ General
codingstyle
designprinciples
+ docstyle
patman
process
release_cycle