Hi Francesco, you are right my eclipse settings are wrong.
So +1 for 2 spaces indentation and no-format for comments in xml documents. Best Regards, Christian -----Original Message----- From: Francesco Chicchiriccò [mailto:ilgro...@apache.org] Sent: Dienstag, 18. Februar 2014 13:22 To: dev@olingo.incubator.apache.org Subject: Re: [DISCUSSION] Code formatting and Jira/Git link On 18/02/2014 12:44, Klevenz, Stephan wrote: > On 18.02.14 12:10, "Amend, Christian" <christian.am...@sap.com> wrote: > >> Hi, >> >> There are two things I would like to bring up which I think should be at >> least be brought up again to avoid confusion :) >> >> First the Jira/Git link. Every commit which states [OLINGO-<issue >> number>] at the beginning will be linked with the corresponding Jira >> issue. We once enabled that feature for the V2 repository and I think >> that this has proved to be quite valuable when producing release notes >> and looking at the commit history as it easily shows what every commit >> was meant for. I enabled this for the V4 repository too as there had be >> no votes against this at the time. So I think we should link every commit >> we make with a Jira issue even if they are small but WDYT? > +1 see [1]. What you'll get out of Jira is really nice, useful and nearly > no effort. > > [1] > https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12325001&sty > leName=&projectId=12314520&Create=Create&atl_token=A5KQ-2QAV-T4JA-FDED|6e89 > e2d544f75821e8282a8c02e58f96f0069d07|lout +1 from me as well >> Secondly code formatting. I unfortunately destroyed Francesco formatting >> by applying the eclipse code style template we have in the repository, >> sorry for that. >> So what can we do to avoid such a thing in the future especially if >> someone is not using eclipse and thus has no way to use the formatting >> tools there? We have a code style which checks for braces and line length >> in our maven build which I think is a good thing but it does not prevent >> formatting the code. So WDYT? > Code formatting ... Groundhog Day (the movie) :-) Checkstyle is configured > here [2] and Eclipse formatter here [3]. > > Major settings are: > > For cleanup: > Remove 'this' qualifier for non static field accesses > Remove 'this' qualifier for non static method accesses > Change non static accesses to static members using declaring type > Change indirect accesses to static members to direct accesses (accesses > through subtypes) > Convert control statement bodies to block > Convert 'for' loops to enhanced 'for' loops > Add final modifier to method parameters > Remove unused imports > Remove unused private methods > Remove unused private constructors > Remove unused private types > Remove unused private fields > Remove unused local variables > Add missing '@Override' annotations > Add missing '@Override' annotations to implementations of interface > methods > Add missing '@Deprecated' annotations > Add missing serial version ID (default 1L) > Organize imports > Format source code > Remove trailing white spaces on all lines > Correct indentation > > > Formatter (Java, XML ...) > Spaces only > indentation size 2 spaces > compact braces format (typical for Java) Actually the kind of formatting I applied yesterday to pom.xml files was exactly this: 2 spaces indentation and no-format for comments (ASF license header in that case). > I don't care much about this concrete settings. If someone want to change > please suggest. At the end we should agree on common settings to avoid > format over while applying any IDE formatter tool. Another thing to consider is the ASF license header in Java files, that looks like /******************************************************************************* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. ******************************************************************************/ while in all other ASF projects I've been involved with it is instead as: /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ Differences are minimal as you can see, and don't seem to matter to RAT. Regards. > [2] > https://git-wip-us.apache.org/repos/asf?p=incubator-olingo-odata4.git;a=blo > b;f=src/checkstyle/config.xml;h=2d4e1697b1b43d947cf955005532252b9b4cb270;hb > =HEAD > [3] > https://git-wip-us.apache.org/repos/asf?p=incubator-olingo-odata4.git;a=tre > e;f=src/eclipse;h=a010cc55bf94c78f1624c076863517f79feebb06;hb=HEAD -- Francesco Chicchiriccò Tirasa - Open Source Excellence http://www.tirasa.net/ Involved at The Apache Software Foundation: member, Syncope PMC chair, Cocoon PMC, Olingo PPMC http://people.apache.org/~ilgrosso/
