diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-10-17 02:51:02 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-10-23 17:41:09 +0300 |
| commit | f353777fb853230a1ea620658c600e005525e46c (patch) | |
| tree | ed2b3c2472d29ac8f60bbb9e003640ee16267f29 | |
| parent | ca260d2f5337536e30d1b2501434bd2a93a3e72e (diff) | |
Documentation: Move coding style under contributing
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>
| -rw-r--r-- | Documentation/coding-style.rst | 6 | ||||
| -rw-r--r-- | Documentation/contributing.rst | 11 | ||||
| -rw-r--r-- | Documentation/index.rst | 1 |
3 files changed, 13 insertions, 5 deletions
diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst index c5324823..9939c7b1 100644 --- a/Documentation/coding-style.rst +++ b/Documentation/coding-style.rst @@ -1,10 +1,8 @@ +.. _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 you are expected to follow them in all code submitted to the project. While strict compliance is desired, exceptions are tolerated when justified with diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index 087f188e..390b96a5 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -53,6 +53,12 @@ Sphinx integration with Doxygen is planned, likely using `Breathe`_ and 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 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:' @@ -62,3 +68,8 @@ By signing your contributions you are certifying your work in accordance with the `Developer's Certificate of Origin`_ .. _Developer's Certificate of Origin: https://developercertificate.org/ + +.. toctree:: + :hidden: + + Coding Style <coding-style> diff --git a/Documentation/index.rst b/Documentation/index.rst index ec222210..84d5f6a8 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -7,6 +7,5 @@ Home <self> Docs <docs> - Coding Style <coding-style> Contribute <contributing> API <api-html/index> |