From patchwork Thu Dec 13 14:53:12 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 46 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id AD635600CC for ; Thu, 13 Dec 2018 15:52:30 +0100 (CET) Received: from avalon.bb.dnainternet.fi (dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 39C42549 for ; Thu, 13 Dec 2018 15:52:30 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1544712750; bh=FsjFBqveTyJXeRnNKT2HsQGgFOx/FlHceMMrALnH8mo=; h=From:To:Subject:Date:From; b=uhVcnkcj7kFzsNaLjqM636uGREtVRPja8FkTdgd2bE9NlKmpydIWlj/7lL+ULmR1v F80N9YQxP9prTmEUSixIDjaeDtTihESj1kN/5osYhKRFccde1QdfkNWPFzW4zG/gww w9rDNpW4fASQvpKKNDdk8mjvl7Mo3nkpp6DF8qfw= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Thu, 13 Dec 2018 16:53:12 +0200 Message-Id: <20181213145313.6754-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/2] Documentation: coding-style: Fix list indentation X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 13 Dec 2018 14:52:30 -0000 The various lists in the document are not quoted blocks. Don't indent them. Signed-off-by: Laurent Pinchart Acked-by: Jacopo Mondi --- Documentation/coding-style.rst | 62 +++++++++++++++++----------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst index d03eb3d5b96d..1b67abed3a53 100644 --- a/Documentation/coding-style.rst +++ b/Documentation/coding-style.rst @@ -26,13 +26,13 @@ Even if the programming language in use is different, the project embraces the In particular, from the kernel style document, the following section are adopted: - * 1 "Indentation" - * 2 "Breaking Long Lines" striving to fit code within 80 columns and - accepting up to 120 columns when necessary - * 3 "Placing Braces and Spaces" - * 3.1 "Spaces" - * 8 "Commenting" with the exception that in-function comments are not - always un-welcome. +* 1 "Indentation" +* 2 "Breaking Long Lines" striving to fit code within 80 columns and + accepting up to 120 columns when necessary +* 3 "Placing Braces and Spaces" +* 3.1 "Spaces" +* 8 "Commenting" with the exception that in-function comments are not + always un-welcome. While libcamera uses the kernel coding style for all typographic matters, the project is a user space library, developed in a different programming language, @@ -47,19 +47,19 @@ few exceptions and relaxed limitations on some subjects. The following exceptions apply to the naming conventions specified in the document: - * File names: libcamera uses the .cpp extensions for C++ source files and - the .h extension for header files - * Variables, function parameters, function names and class members use - camel case style, with the first letter in lower-case (as in 'camelCase' - and not 'CamelCase') - * Types (classes, structs, type aliases, and type template parameters) use - camel case, with the first letter in capital case (as in 'CamelCase' and - not 'camelCase') - * Enum members use 'CamelCase', while macros are in capital case with - underscores in between - * All formatting rules specified in the selected sections of the Linux kernel - Code Style for indentation, braces, spacing, etc - * Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__' +* File names: libcamera uses the .cpp extensions for C++ source files and + the .h extension for header files +* Variables, function parameters, function names and class members use + camel case style, with the first letter in lower-case (as in 'camelCase' + and not 'CamelCase') +* Types (classes, structs, type aliases, and type template parameters) use + camel case, with the first letter in capital case (as in 'CamelCase' and + not 'camelCase') +* Enum members use 'CamelCase', while macros are in capital case with + underscores in between +* All formatting rules specified in the selected sections of the Linux kernel + Code Style for indentation, braces, spacing, etc +* Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__' C++ Specific Rules @@ -68,14 +68,14 @@ C++ Specific Rules The code shall be implemented in C++03, extended with the following C++-11-specific features: - * Initializer lists - * Type inference (auto and decltype) - Type inference shall be used with caution, to avoid drifting towards an - untyped language. - * Range-based for loop - * Lambda functions - * Explicit overrides and final - * Null pointer constant - * General-purpose smart pointers (std::unique_ptr), deprecating std::auto_ptr. - Smart pointers, as well as shared pointers and weak pointers, shall not be - overused. +* Initializer lists +* Type inference (auto and decltype) + Type inference shall be used with caution, to avoid drifting towards an + untyped language. +* Range-based for loop +* Lambda functions +* Explicit overrides and final +* Null pointer constant +* General-purpose smart pointers (std::unique_ptr), deprecating std::auto_ptr. + Smart pointers, as well as shared pointers and weak pointers, shall not be + overused. From patchwork Thu Dec 13 14:53:13 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 47 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 073F6600CC for ; Thu, 13 Dec 2018 15:52:31 +0100 (CET) Received: from avalon.bb.dnainternet.fi (dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 88A0F568 for ; Thu, 13 Dec 2018 15:52:30 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1544712750; bh=1PCrNpDL/PYO0OOzrgQv3vXMC0H3+BSmS/nhj4k9q/g=; h=From:To:Subject:Date:In-Reply-To:References:From; b=p268RUCY9mr5j4+BOwmk93fRb+uz3xAr6BuAu8PQo5Kl0N2RRD2hPS5ZOhrZs8mtF y5x4A94hVxwtCGY2NApgww5htnVhBGM9u9kSeVJnA7SG/6iA1pkJfjSyd73UU3QIST beqa9rfqpughtP9740eKYP5qrnq95o1+XFzpFi4c= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Thu, 13 Dec 2018 16:53:13 +0200 Message-Id: <20181213145313.6754-2-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 In-Reply-To: <20181213145313.6754-1-laurent.pinchart@ideasonboard.com> References: <20181213145313.6754-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 2/2] Documentation: contributing: Mark command line as shell code-block X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 13 Dec 2018 14:52:31 -0000 The git clone command line is a (single line) block of shell code, mark it appropriately. Signed-off-by: Laurent Pinchart --- Documentation/contributing.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index 0eedadc94906..8f6f40b0795d 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -29,6 +29,8 @@ Source Code libcamera is in early stages of development, and no releases are available yet. The source code is available from the project's `git tree`_, hosted by `LinuxTV`_. +.. code-block:: shell + $ git clone git://linuxtv.org/libcamera.git .. _git tree: https://git.linuxtv.org/libcamera.git/