[libcamera-devel] [PATCH 1/8] Documentation: Move coding style under contributing

[Kieran Bingham]

Hi Laurent,

On 21/10/2019 11:24, Laurent Pinchart wrote:
> 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 at ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> ---
>  Documentation/coding-style.rst |  6 ++----
>  Documentation/contributing.rst | 11 +++++++++++
>  Documentation/index.rst        |  1 -
>  3 files changed, 13 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
> index 8dd1afce1a2c..9940ec10f330 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 087f188e5d51..390b96a55699 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 ec2222108e8a..84d5f6a88caf 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>
> 

-- 
Regards
--
Kieran