Coding conventions (was: [Patch] Make tls.el support certificate verification)

[Reiner Steib <reinersteib+gmane@imap.cc>]

On Tue, Nov 27 2007, Elias Oltmanns wrote:

>> See http://article.gmane.org/gmane.emacs.gnus.commits/5529 for my
>> cosmetic/style changes.
>
> In the cvs trunk I can see that you made some adjustments to line breaks
> as well.  What is the maximum line length in doc strings?  

The first line should be short enough to fit into an apropos buffer
(with a width of 80 columns).  As for the other lines, I simply hit
M-q (with Emacs' default settings).  `M-x checkdoc RET' helps to fix
common mistakes for doc string and other style issues.

> Also, is there a comprehensive source for information about Emacs
> and Gnus codingstyle and good practice?  

For Gnus: `texi/gnus-coding.texi'.  As Gnus is part of Emacs, we try
to follow the conventions for Emacs.  E.g. (info "(elisp)Tips"), (info
"(elisp)Coding Conventions").  I don't think there's a comprehensive
source.

> And what is the canonical way to provide ChangeLog entries if I have
> no commit privileges or, to put it another way, the attached patch
> alright in this respect?

As the ChangeLog is modified very often, patches usually don't apply
properly.  Therefore it's better to provide the ChangeLog directly in
the message, e.g. ...

--8<---------------cut here---------------start------------->8---
2007-11-27  Elias Oltmanns  <eo@nebensachen.de>

	* tls.el (open-tls-stream): Actually consult tls-checktrust to see if
	certs should be verified and what is to be done in the event of a
	verification failure.
--8<---------------cut here---------------end--------------->8---

Note that the colon after "tls.el" was not correct.

Then the committer can simply Copy&Paste it and adjust the date.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/