john-dev - Re: Coding Style

Follow @Openwall on Twitter for new release announcements and other news

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CABtNtWGOFSLdySuq-C92TJ4L=F=RG-rRZwZw8iR3+42VKLyomg@mail.gmail.com>
Date: Wed, 8 Apr 2015 17:29:30 +0800
From: Kai Zhao <loverszhao@...il.com>
To: john-dev@...ts.openwall.com
Subject: Re: Coding Style

> 1) it should be possible to convert code to it automatically,
>   a) to convert existing code (e.g. all jumbo);
>   b) to convert new code before committing it to the repo;

I have done some research and experiment on the automatic tools. Here are
the tools:

1. Commercial

    - Jindent
    - Polystyle
    - Pretty Printer
    - ScrEnc
    - SQCBW

2. Free

    - GNU Indent
    - Artistic Style
    - UniversalIndentGUI
    - Uncrustify
    - GreatCode

However, I think we'd better not use these tools. There are two reasons.
Firstly, linux kernel which our coding style very similar to does not use
it.
Secondly, the tools is arbitrary. E.g., if we set the max column 80, but
there are some cases which we may exceed column 80.

I think kernel does very well on the coding style. They use the script
checkpatch.pl to check the coding style, and add it to the git pre-commit
hooks, so each patch will be checked before commit.

The script generates errors and warnings. It depends on the committers to
judge whether change their code.

Thanks,

Kai

Content of type "text/html" skipped

Confused about mailing lists and their use? Read about mailing lists on Wikipedia and check out these guidelines on proper formatting of your messages.