From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 27359 invoked by alias); 19 Oct 2010 18:45:01 -0000 Received: (qmail 27311 invoked by uid 22791); 19 Oct 2010 18:45:00 -0000 X-SWARE-Spam-Status: No, hits=-0.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout23.012.net.il (HELO mtaout23.012.net.il) (80.179.55.175) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 19 Oct 2010 18:44:53 +0000 Received: from conversion-daemon.a-mtaout23.012.net.il by a-mtaout23.012.net.il (HyperSendmail v2007.08) id <0LAJ00500W0O8300@a-mtaout23.012.net.il> for gdb-patches@sourceware.org; Tue, 19 Oct 2010 20:44:31 +0200 (IST) Received: from HOME-C4E4A596F7 ([84.229.93.189]) by a-mtaout23.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LAJ005HMW250Q40@a-mtaout23.012.net.il>; Tue, 19 Oct 2010 20:44:30 +0200 (IST) Date: Tue, 19 Oct 2010 18:45:00 -0000 From: Eli Zaretskii Subject: Re: [doc RFA] Clean up coding standards, add python coding standards. In-reply-to: <20101019155311.038842461AD@ruffy.mtv.corp.google.com> To: dje@google.com (Doug Evans) Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83bp6q9g4r.fsf@gnu.org> References: <20101019155311.038842461AD@ruffy.mtv.corp.google.com> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2010-10/txt/msg00298.txt.bz2 > Date: Tue, 19 Oct 2010 08:53:10 -0700 (PDT) > From: dje@google.com (Doug Evans) > > I think it is wrong that a discussion of cleanups appears in the same > chapter as coding standards. Ditto for a few other subsections > in the existing Coding chapter. > > This patch creates a new Coding Standards chapter to put such things in, > and I've added a section on Python coding standards. Thanks. > I'm not happy with the name "Miscellaneous Coding Guidelines" but it > works well enough for me. Feel free to suggest an alternatives. "Misc Guidelines"? In general, node names should be short, because they are displayed on the mode line and header line of the Info readers, where space is at premium. (Section names, OTOH, can be longer.) > Ok to check in? Could you tell me if you made any changes in the "Internal Error Handling" part, or just moved it without any changes? If you just moved it, I won't need to review that part. > -* Coding:: > +* Miscellaneous Coding Guidelines:: > +* Coding Standards:: I think "Coding Standards" should be before the new "Misc" section. > +@value{GDBN} follows the published @code{Python} coding standards in > +@code{PEP008}. > +See @uref{http://www.python.org/dev/peps/pep-0008/, PEP008}. This is suboptimal usage of @uref. I suggest this instead: @value{GDBN} follows the published @code{Python} coding standards in @uref{http://www.python.org/dev/peps/pep-0008/, @code{PEP008}}. > +In addition, the Google standards are also followed where they do not > +conflict with @code{PEP008}. > +See @uref{http://google-styleguide.googlecode.com/svn/trunk/pyguide.html, > +Google Python Style Guide}. Same here: In addition, the guidelines in the @uref{http://google-styleguide.googlecode.com/svn/trunk/pyguide.html, Google Python Style Guide} are also followed where they do not conflict with @code{PEP008}. Okay with those changes (assuming that the "Internal Error Handling" stuff was moved without any change). Thanks for taking care of this.