Difference between revisions of "Code reformatting"

From OpenSSLWiki
Jump to navigationJump to search
(Created page with " == Code Reformatting == We recently (early 2015) reformatted all the OpenSSL code, in all release branches. As a result the code is consistent and, to almost everyone, easi...")
 
 
Line 2: Line 2:
 
== Code Reformatting ==
 
== Code Reformatting ==
  
We recently (early 2015) reformatted all the OpenSSL code, in all release branches.
+
In 2015, all the OpenSSL code was reformatted, in all release branches.
  
 
As a result the code is consistent and, to almost everyone, easier to read.
 
As a result the code is consistent and, to almost everyone, easier to read.
  
The style policy is at [[https://openssl.org/about/codingstyle.txt]]
+
[https://www.openssl.org/policies/codingstyle.txt Coding Style Policy]
  
 
Matt wrote a couple of blog entries about the reformatting: [[https://www.openssl.org/blog/blog/2015/01/05/source-code-reformat/]] and [[https://www.openssl.org/blog/blog/2015/02/11/code-reformat-finished/]].
 
Matt wrote a couple of blog entries about the reformatting: [[https://www.openssl.org/blog/blog/2015/01/05/source-code-reformat/]] and [[https://www.openssl.org/blog/blog/2015/02/11/code-reformat-finished/]].

Latest revision as of 15:30, 8 March 2018

Code Reformatting[edit]

In 2015, all the OpenSSL code was reformatted, in all release branches.

As a result the code is consistent and, to almost everyone, easier to read.

Coding Style Policy

Matt wrote a couple of blog entries about the reformatting: [[1]] and [[2]].

If you have a smaller number of local patches, you might find this recipe useful to upgrade:

  • Take the original release you are currently using. Reformat it according to the second blog entry. Don't worry too much about minor failures or inconsistencies. Save that.
  • Take your patched release. Reformat it according to the second blog entry. Don't worry too much about minor failures or inconsistencies. Save that.
  • Run a diff between the two releases. You should, for the most part, have just your patches, reformatted.