summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2023-04-22 18:32:08 -0400
committerTom Rini <trini@konsulko.com>2023-04-22 18:32:08 -0400
commit39bc4e12aba9b415c2bc19c0209661146c6e6f2a (patch)
tree1133f0583ce5dbfdcc650f0c4ded1aa4496be10f /doc
parent802132c48a2e6b66ec83b7bb66fb96f2ba87c957 (diff)
parentb10bfd0019f601e2608370ed47741da201423d55 (diff)
downloadu-boot-39bc4e12aba9b415c2bc19c0209661146c6e6f2a.tar.gz
Merge tag 'efi-2023-07-rc1-2' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for efi-2023-07-rc1-2 Documentation: * Describe Python coding style UEFI: * Enable tests for authenticated capsules on the sandbox * Fix pylint warnings * Correct struct efi_hii_keyboard_layout definition
Diffstat (limited to 'doc')
-rw-r--r--doc/develop/codingstyle.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst
index 1d5d0192b3..3d05a6b988 100644
--- a/doc/develop/codingstyle.rst
+++ b/doc/develop/codingstyle.rst
@@ -19,6 +19,10 @@ The following rules apply:
applies only to Linux, not to U-Boot. Only large hunks which are copied
unchanged from Linux may retain that comment format.
+* Python code shall conform to `PEP8 (Style Guide for Python Code)
+ <https://peps.python.org/pep-0008/>`_. Use `pylint
+ <https://github.com/pylint-dev/pylint>`_ for checking the code.
+
* Use patman to send your patches (``tools/patman/patman -H`` for full
instructions). With a few tags in your commits this will check your patches
and take care of emailing them.
@@ -67,6 +71,9 @@ documentation is strongly advised. The Linux kernel `kernel-doc
<https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html>`_
documentation applies with no changes.
+Our Python code documentation follows `PEP257 (Docstring Conventions)
+<https://peps.python.org/pep-0257/>`_.
+
Use structures for I/O access
-----------------------------