You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2017/03/27 20:51:54 UTC
[3/3] nifi-minifi-cpp git commit: MINIFI-225: Add Linter for Google
style guide
MINIFI-225: Add Linter for Google style guide
This closes #69.
Signed-off-by: Aldrin Piri <al...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/commit/bca0a066
Tree: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/tree/bca0a066
Diff: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/diff/bca0a066
Branch: refs/heads/master
Commit: bca0a0661c05365268ef3812a0a9acbd81977dd7
Parents: 070d875
Author: Marc Parisi <ph...@apache.org>
Authored: Mon Mar 20 10:25:37 2017 -0400
Committer: Aldrin Piri <al...@apache.org>
Committed: Mon Mar 27 16:51:17 2017 -0400
----------------------------------------------------------------------
CMakeLists.txt | 8 +-
LICENSE | 30 +
README.md | 13 +
thirdparty/google-styleguide/cpplint.py | 6154 +++++++++++++++++++++++
thirdparty/google-styleguide/run_linter.sh | 24 +
5 files changed, 6227 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/blob/bca0a066/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/CMakeLists.txt b/CMakeLists.txt
index f3f7f82..418220d 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -135,5 +135,9 @@ enable_testing(test)
add_custom_target(
docker
COMMAND ${CMAKE_SOURCE_DIR}/docker/DockerBuild.sh 1000 1000 ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH} minificppsource ${CMAKE_SOURCE_DIR}
- WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/docker/
-)
+ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/docker/)
+
+# Create a custom build target that will run the linter.
+add_custom_target(
+ linter
+ COMMAND ${CMAKE_SOURCE_DIR}/thirdparty/google-styleguide/run_linter.sh ${CMAKE_SOURCE_DIR}/libminifi/include/ ${CMAKE_SOURCE_DIR}/libminifi/src/ )
http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/blob/bca0a066/LICENSE
----------------------------------------------------------------------
diff --git a/LICENSE b/LICENSE
index aed894b..8a0f32e 100644
--- a/LICENSE
+++ b/LICENSE
@@ -208,6 +208,36 @@ notices and license terms. Your use of the source code for the these
subcomponents is subject to the terms and conditions of the following
licenses.
+This product bundles 'cpplint.py' which is available under a 3-Clause BSD License.
+
+ Copyright (c) 2009 Google Inc. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the following disclaimer
+ in the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Google Inc. nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
This product bundles 'libuuid' which is available under a "3-clause BSD" license.
Copyright (C) 1996, 1997 Theodore Ts'o.
http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/blob/bca0a066/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b254b32..484c97a 100644
--- a/README.md
+++ b/README.md
@@ -308,6 +308,19 @@ MiNiFi can also be installed as a system service using minifi.sh with an optiona
## Documentation
See https://nifi.apache.org/minifi for the latest documentation.
+## Contributing
+
+We welcome all contributions to Apache MiNiFi. To make development easier, we've included
+the linter for the Google Style guide. Google provides an Eclipse formatter for their style
+guide. It is located [here](https://github.com/google/styleguide/blob/gh-pages/eclipse-cpp-google-style.xml).
+New contributions are expected to follow the Google style guide when it is reasonable.
+Additionally, all new files must include a copy of the Apache License Header.
+
+Once you have completed your changes, including source code and tests, you can verify that
+you follow the Google style guide by running the following command:
+ $ make linter.
+This will provide output for all source files.
+
## License
Except as otherwise noted this software is licensed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)