Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Pedro Alves <pedro@codesourcery.com>
To: gdb-patches@sourceware.org
Subject: [doc/gdbint] Mention some formatting guidelines for casts and unary operators
Date: Tue, 01 Feb 2011 16:28:00 -0000	[thread overview]
Message-ID: <201102011628.32860.pedro@codesourcery.com> (raw)

This is a follow up to a discussion from last November
<http://sourceware.org/ml/gdb-patches/2010-11/msg00121.html>,
that sort of came up today again.

It imports and casts to stone these recommendations (from GCC):

 Use...                     ...instead of
 !x                         ! x
 ~x                         ~ x
 -x (unary minus)           - x
 (foo) x (cast)             (foo)x
 *x (pointer dereference)   * x


which we have been largely following already anyway.

Okay?

-- 
Pedro Alves

2011-02-01  Pedro Alves  <pedro@codesourcery.com>

	* gdbint.texinfo (Formatting): Mention some formatting guidelines
	for casts and unary operators.

---
 gdb/doc/gdbint.texinfo |   24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

Index: src/gdb/doc/gdbint.texinfo
===================================================================
--- src.orig/gdb/doc/gdbint.texinfo	2011-01-13 15:07:50.000000000 +0000
+++ src/gdb/doc/gdbint.texinfo	2011-02-01 16:08:47.184645005 +0000
@@ -5785,7 +5785,8 @@ compiler.
 
 @cindex source code formatting
 The standard GNU recommendations for formatting must be followed
-strictly.
+strictly.  Any @value{GDBN}-specific deviation from GNU
+recomendations is described below.
 
 A function declaration should not have its name in column zero.  A
 function definition should have its name in column zero.
@@ -5828,6 +5829,27 @@ void * foo;
 void* foo;
 @end smallexample
 
+In addition, whitespace around casts and unary operators should follow
+the following guidelines:
+
+@multitable @columnfractions .2 .2 .8
+@item Use... @tab ...instead of @tab
+
+@item @code{!x}
+@tab @code{! x}
+@item @code{~x}
+@tab @code{~ x}
+@item @code{-x}
+@tab @code{- x}
+@tab (unary minus)
+@item @code{(foo) x}
+@tab @code{(foo)x}
+@tab (cast)
+@item @code{*x}
+@tab @code{* x}
+@tab (pointer dereference)
+@end multitable
+
 @subsection Comments
 
 @cindex comment formatting


             reply	other threads:[~2011-02-01 16:28 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-01 16:28 Pedro Alves [this message]
2011-02-01 18:48 ` Michael Snyder
2011-02-01 18:50 ` Eli Zaretskii
2011-02-04 17:01   ` Pedro Alves
2011-02-04 18:29     ` Eli Zaretskii
2011-02-04 19:12       ` Pedro Alves

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201102011628.32860.pedro@codesourcery.com \
    --to=pedro@codesourcery.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox