On 06/02/2017 12:44, David Sommerseth wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> I have ACKed and applied this, just to get this one resolved.  But I am very
> disappointed that you have yet again completely ignored the guidelines
> described in the URL[1] already provided to you - which describes how a patch
> and commit message should look like.
>
> In fact - your SUBJECT line was 167 characters long, _including_ a URL.  It
> did not even have a proper body message.  *sigh*

The 80 character limit is only documented here:

<https://community.openvpn.net/openvpn/wiki/CodeStyle>

This is a fairly new page and not linked to from anywhere. On top of 
that the page says that "This coding style is not final and not yet in 
effect."

Moreover, our developer documentation is quite a mess right now:

<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation>
<https://community.openvpn.net/openvpn/wiki/Contributing>

For example, the DeveloperDocumentation page links to here:

<https://community.openvpn.net/openvpn/wiki/CodingConventions>

That page is a stub with very little and possibly outdated/false 
information. Then we have

<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation#Formatting>

which says we use "GNU coding style". And then we have the actual 2.4 
code style instructions here:

<https://community.openvpn.net/openvpn/wiki/CodeStyle>

There is a fairly well-hidden link on the DeveloperDocumentation page to 
these Git commit message instructions:

<http://who-t.blogspot.com/2009/12/on-commit-messages.html>

I think that blog posting is too verbose. The essential information, 
such as the "seven rules" you linked to should be directly on the 
DeveloperDocumentation page, with links to the original documents.

I don't want to argue whether Ilya should know the 80 character limit or 
not. But how can we expect _new_ developers to get our rules if they are 
not documented properly or if documentation is contradictory? Or if the 
documentation is hidden as well as the CodeStyle page?

I will create a copy of the DeveloperDocumentation page and clean that 
one up. Then I will send a link so that others can have a look.

-- 
Samuli Seppänen
Community Manager
OpenVPN Technologies, Inc

irc freenode net: mattock


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

Reply via email to