[incubator-mxnet] branch master updated: [Master] Clang-format description on a wiki (#20612)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhasheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new f46b25b  [Master] Clang-format description on a wiki (#20612)
f46b25b is described below

commit f46b25b747bfb2b82d24219b3087030a75748e25
Author: mozga <ma...@intel.com>
AuthorDate: Sat Oct 16 01:53:20 2021 +0200

    [Master] Clang-format description on a wiki (#20612)
    
    * Clang-format description on a wiki
    
    * Add clang link to other files
    
    * Tool word is removed from the sentence
---
 .../src/pages/community/clang_format_guide.md      | 58 ++++++++++++++++++++++
 docs/static_site/src/pages/community/code_guide.md |  2 +-
 .../src/pages/community/pull_request.md            |  2 +-
 3 files changed, 60 insertions(+), 2 deletions(-)

diff --git a/docs/static_site/src/pages/community/clang_format_guide.md b/docs/static_site/src/pages/community/clang_format_guide.md
new file mode 100644
index 0000000..02ece66
--- /dev/null
+++ b/docs/static_site/src/pages/community/clang_format_guide.md
@@ -0,0 +1,58 @@
+---
+layout: page
+title: Clang format
+subtitle: Clang format in MXNet codebase for reviewers and contributors.
+action: Contribute
+action_url: /community/index
+permalink: /community/code_guide
+---
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements.  See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership.  The ASF licenses this file -->
+<!--- to you 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 -->
+
+<!---   http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied.  See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+Clang-format Guide and Tips
+===================
+
+This wiki page describes how to set up clang-format tool as a part of your worklow. Running the command given in the description will fix clang-format problem.
+
+
+- Add `tools/lint/git-clang-format-13 ` to your `$PATH`. Once its added to your `$PATH`, running `git clang-format` will invoke it.
+```bash
+git clang-format
+```
+
+
+- To reformat chosen file just do: 
+```bash
+# `_FILE_NAME_` is the name of a file to be formatted.
+# i - apply edits to files instead of displaying a diff
+clang-format -i _FILE_NAME_
+```
+
+- To reformat all the lines in the latest git commit, just do: 
+```bash
+git diff -U0 --no-color HEAD^ | clang-format-diff.py -i -p1
+
+```
+
+- If you want to apply clang-format only to the changed lines in each commit do the following:
+```bash
+# If it's a child of origin/master, the following command-line could be used:
+# If you want to run this command on another brnach, then origin/master needs to be replaced.
+export COMMIT_SHA=$(git rev-list --ancestry-path origin/master..HEAD | tail -n 1)
+
+git filter-branch --tree-filter 'git-clang-format $COMMIT_SHA^' -- $COMMIT_SHA..HEAD
+```
\ No newline at end of file
diff --git a/docs/static_site/src/pages/community/code_guide.md b/docs/static_site/src/pages/community/code_guide.md
index ea24aef..fd5831e 100644
--- a/docs/static_site/src/pages/community/code_guide.md
+++ b/docs/static_site/src/pages/community/code_guide.md
@@ -33,7 +33,7 @@ contributing and process.
 C++ Code Styles
 ---------------
 
--   Use the [Google C/C++ style](https://google.github.io/styleguide/cppguide.html).
+-   Use the [clang-format]({% link pages/community/clang_format_guide.md %}) to reformat your code.
 -   The public facing functions are documented in [doxygen](https://www.doxygen.nl/manual/docblocks.html) format.
 -   Favor concrete type declaration over `auto` as long as it is short.
 -   Favor passing by const reference (e.g. `const Expr&`) over passing
diff --git a/docs/static_site/src/pages/community/pull_request.md b/docs/static_site/src/pages/community/pull_request.md
index fea5474..2520d55 100644
--- a/docs/static_site/src/pages/community/pull_request.md
+++ b/docs/static_site/src/pages/community/pull_request.md
@@ -39,7 +39,7 @@ detailed guidelines.
     ```
 
 -   Make sure code style check pass by typing the following command, and
-    all the existing test-cases pass.
+    all the existing test-cases pass. Use the [clang-format]({% link pages/community/clang_format_guide.md %}) to reformat your code.
 
     ```bash
     # Reproduce the lint procedure in the CI.