diff mbox series

[ovs-dev] coding-style: Remove redundant symbols from the examples.

Message ID 20181115115535.29313-1-i.maximets@samsung.com
State Accepted
Headers show
Series [ovs-dev] coding-style: Remove redundant symbols from the examples. | expand

Commit Message

Ilya Maximets Nov. 15, 2018, 11:55 a.m. UTC
Some backslashes was added while converting from .md to .rst.
These symbols are printable in both pdf and html docs and
should be removed.

CC: Stephen Finucane <stephen@that.guru>
Fixes: d124a408a4bc ("doc: Convert CodingStyle to rST")
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
---
 Documentation/internals/contributing/coding-style.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Ben Pfaff Nov. 15, 2018, 2:29 p.m. UTC | #1
On Thu, Nov 15, 2018 at 02:55:35PM +0300, Ilya Maximets wrote:
> Some backslashes was added while converting from .md to .rst.
> These symbols are printable in both pdf and html docs and
> should be removed.
> 
> CC: Stephen Finucane <stephen@that.guru>
> Fixes: d124a408a4bc ("doc: Convert CodingStyle to rST")
> Signed-off-by: Ilya Maximets <i.maximets@samsung.com>

Thanks, applied to master.
diff mbox series

Patch

diff --git a/Documentation/internals/contributing/coding-style.rst b/Documentation/internals/contributing/coding-style.rst
index 3ce104994..28cbec28b 100644
--- a/Documentation/internals/contributing/coding-style.rst
+++ b/Documentation/internals/contributing/coding-style.rst
@@ -530,7 +530,7 @@  Do not put any white space around postfix, prefix, or grouping operators:
 Exception 1: Put a space after (but not before) the "sizeof" keyword.
 
 Exception 2: Put a space between the () used in a cast and the expression whose
-type is cast: ``(void \*) 0``.
+type is cast: ``(void *) 0``.
 
 Break long lines before the ternary operators ? and :, rather than after
 them, e.g.
@@ -585,7 +585,7 @@  Try to avoid casts. Don't cast the return value of malloc().
 
 The "sizeof" operator is unique among C operators in that it accepts two very
 different kinds of operands: an expression or a type. In general, prefer to
-specify an expression, e.g. ``int *x = xmalloc(sizeof *\ x);``. When the
+specify an expression, e.g. ``int *x = xmalloc(sizeof *x);``. When the
 operand of sizeof is an expression, there is no need to parenthesize that
 operand, and please don't.