From d023c60c7427a8e582491723c28350d44335f248 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Beraud?= Date: Tue, 21 Jul 2020 13:33:41 +0200 Subject: Adding pre-commit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Introduced changes: - pre-commit config and rules - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks. - Applying fixes for pre-commit compliance in all code. Also commit hash will be used instead of version tags in pre-commit to prevend arbitrary code from running in developer's machines. pre-commit will be used to: - trailing whitespace; - Replaces or checks mixed line ending (mixed-line-ending); - Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker); - Checks that non-binary executables have a proper shebang (check-executables-have-shebangs); - Check for files that contain merge conflict strings (check-merge-conflict); - Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements); - Attempts to load all yaml files to verify syntax (check-yaml); - Run flake8 checks (flake8) (local) For further details about tests please refer to: https://github.com/pre-commit/pre-commit-hooks Change-Id: Ifc5ee35d399c628604ec1644eb447936803c45f5 Signed-off-by: Moisés Guimarães de Medeiros --- doc/source/conf.py | 3 ++- doc/source/configuration/index.rst | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) mode change 100755 => 100644 doc/source/conf.py (limited to 'doc/source') diff --git a/doc/source/conf.py b/doc/source/conf.py old mode 100755 new mode 100644 index faff562..d905196 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,6 @@ # -*- coding: utf-8 -*- +# Copyright (C) 2020 Red Hat, Inc. +# # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -22,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', 'oslo_config.sphinxext', 'openstackdocstheme', 'stevedore.sphinxext', diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 6ca076e..0a2a4ec 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -3,7 +3,7 @@ Middlewares and configuration ============================= Middlewares can be configured in multiple fashion depending of the -application needs. Here is some use-cases: +application needs. Here is some use-cases: Configuration from the application ---------------------------------- @@ -24,8 +24,8 @@ The paste filter (in /etc/my_app/api-paste.ini) will looks like:: [filter:sizelimit] use = egg:oslo.middleware#sizelimit - # In case of the application doesn't use the global oslo.config - # object. The middleware must known the app name to load + # In case of the application doesn't use the global oslo.config + # object. The middleware must known the app name to load # the application configuration, by setting this: # oslo_config_project = my_app -- cgit v1.2.1