NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

Documentation: Move coding style under contributing

Browse source 
The coding style isn't so important that it has to be displayed on the
top contents bar. Move it to the contributing section.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2019-10-17 02:51:02 +03:00
parent ca260d2f53
commit f353777fb8
3 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Documentation/coding-style.rst
View file

@ -1,10 +1,8 @@
.. _coding-style-guidelines:
Coding Style Guidelines Coding Style Guidelines
======================= =======================
The libcamera project has high standards of stability, efficiency and
reliability. To achieve those, the project goes to great length to produce
code that is as easy to read, understand and maintain as possible.
These coding guidelines are meant to ensure code quality. As a contributor These coding guidelines are meant to ensure code quality. As a contributor
you are expected to follow them in all code submitted to the project. While you are expected to follow them in all code submitted to the project. While
strict compliance is desired, exceptions are tolerated when justified with strict compliance is desired, exceptions are tolerated when justified with

11
Documentation/contributing.rst
View file

@ -53,6 +53,12 @@ Sphinx integration with Doxygen is planned, likely using `Breathe`_ and
Submitting Patches Submitting Patches
------------------ ------------------
The libcamera project has high standards of stability, efficiency and
reliability. To achieve those, the project goes to great length to produce
code that is as easy to read, understand and maintain as possible. This is
made possible by a set of :ref:`coding-style-guidelines` that all submissions
are expected to follow.
Patches submitted to the libcamera project must be certified as suitable for Patches submitted to the libcamera project must be certified as suitable for
integration into an open source project. As such libcamera follows the same integration into an open source project. As such libcamera follows the same
model as utilised by the Linux kernel, and requires the use of 'Signed-off-by:' model as utilised by the Linux kernel, and requires the use of 'Signed-off-by:'
@ -62,3 +68,8 @@ By signing your contributions you are certifying your work in accordance with
the `Developer's Certificate of Origin`_ the `Developer's Certificate of Origin`_
.. _Developer's Certificate of Origin: https://developercertificate.org/ .. _Developer's Certificate of Origin: https://developercertificate.org/
.. toctree::
:hidden:
Coding Style <coding-style>

1
Documentation/index.rst
View file

@ -7,6 +7,5 @@
Home <self> Home <self>
Docs <docs> Docs <docs>
Coding Style <coding-style>
Contribute <contributing> Contribute <contributing>
API <api-html/index> API <api-html/index>