2017-02-07 15:09 GMT+05:00 Samuli Seppänen <sam...@openvpn.net>:
> On 07/02/2017 11:06, Samuli Seppänen wrote:
>
>> 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>
>>
>>
> Actually, that was just the line length for _code_, not for commit
> messages. So the only indirect guideline for Git commit message line length
> was
>
> "The maximum length of the line differs between projects, it's usually
> somewhere between 50 and 78 characters"
>
> which was on this page:
>
> <http://who-t.blogspot.fi/2009/12/on-commit-messages.html>
>
> The "seven rules" URL David linked to says the following:
>
> * Limit the subject line to 50 characters
> * Wrap the body at 72 characters
>
as I am somehow related to this topic...
well, I did not mean to annoy David in purpose, it happened accidently (as
I already said).
as for compliance check, it will always annoy people if it is something
written somewhere. people will forget to have a look at it.
can we involve something like that
https://github.com/openresty/lua-nginx-module/blob/master/.travis.yml#L61-L62
?
and other checks we agreed upon
>
> I can't recall us ever agreeing to such limits.
>
> Let's agree on what we want and then document it properly.
>
>
> --
> Samuli Seppänen
> Community Manager
> OpenVPN Technologies, Inc
>
> irc freenode net: mattock
>
> 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/DeveloperDocumen
>> tation#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.
>>
>>
>
>
------------------------------------------------------------------------------
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
