[Opensim-dev] Wholesale reformatting of files (UNCLASSIFIED)

[Melanie]

Hi Doug,

the standards are definitely still part of our coding, however,
there is also a requirement to separate functional and cosmetic work
into separate patches.

This is so that downstream projects are able to discount merge
issues in commits that are marked as cosmetic. As an upstream
project we do have a responsibility to not make the life of
downstream projects unnecessarily hard. Keeping cosmetic and
functional work separate is something that helps achieve that goal.

For the same reason, restructuring of classes and reordering of
functions, which is not normally done, when it does become necessary
should be separated so that actual code changes are not included
with reordering or cleanup. That allows downstream to look at the
new order of methods and reorder their versions instead of having
hundreds of conflicts trying to merge line-by-line.

- Melanie

On 28/05/2015 20:53, Maxwell, Douglas CIV USARMY ARL (US) wrote:
> Classification: UNCLASSIFIED
> Caveats: NONE
> 
> As a rule, we are adhering to the coding standards of the target project.
> In this case our guide is here:
> http://opensimulator.org/wiki/Coding_standards
> 
> Our team has been correcting any improperly formatted code as we come across
> it.  We are finding a lot of mismatched formatting and we believed we were
> doing your community a service by performing these corrections as we spotted
> them.
> 
> If these standards are no longer a part of your standard operating
> procedures, please update your coding standards documentation and we will
> adjust accordingly.
> 
> Thank you for your comment.
> 
> v/r -doug
> 
> Douglas Maxwell
> Science and Technology Manager
> Virtual World Strategic Applications
> U.S. Army Research Lab
> Simulation & Training Technology Center (STTC)
> (c) (407) 242-0209
> 
> 
> 
> -----Original Message-----
> From: opensim-dev-bounces at opensimulator.org
> [mailto:opensim-dev-bounces at opensimulator.org] On Behalf Of James Hughes
> Sent: Tuesday, May 26, 2015 9:01 PM
> To: OpenSim Developers
> Subject: [Opensim-dev] Wholesale reformatting of files
> 
> The last round of patches from MOSES team reformatted Scene.cs removing
> intentions after constructs like: if, foreach, etc. if there is only one
> line following. I have not seen other code like this in OpenSimulator, and
> it doesn't fit any coding conventions I have seen for C#. Also, Wholesale
> formatting of huge files makes it nearly impossible to see what changes were
> actually made to the file. And finally these cause unnecessary merge
> conflicts in private branches.
> 
> I would like to see these removed from the last round of files and make sure
> that all commits contain only essential changes and constructs follow
> commonly used C# coding style. If it is absolutely necessary to re-format a
> file, that is all that should be committed and the commit message should
> indicate that.
> 
> Thanks,
> -James
> BlueWall
> 
> _______________________________________________
> Opensim-dev mailing list
> Opensim-dev at opensimulator.org
> http://opensimulator.org/cgi-bin/mailman/listinfo/opensim-dev
> 
> Classification: UNCLASSIFIED
> Caveats: NONE
> 
> 
> 
> 
> 
> _______________________________________________
> Opensim-dev mailing list
> Opensim-dev at opensimulator.org
> http://opensimulator.org/cgi-bin/mailman/listinfo/opensim-dev