From dev-return-10006-apmail-jackrabbit-dev-archive=jackrabbit.apache.org@jackrabbit.apache.org Fri Dec 08 10:45:47 2006 Return-Path: Delivered-To: apmail-jackrabbit-dev-archive@www.apache.org Received: (qmail 42465 invoked from network); 8 Dec 2006 10:45:45 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 8 Dec 2006 10:45:45 -0000 Received: (qmail 81810 invoked by uid 500); 8 Dec 2006 10:45:53 -0000 Delivered-To: apmail-jackrabbit-dev-archive@jackrabbit.apache.org Received: (qmail 81774 invoked by uid 500); 8 Dec 2006 10:45:52 -0000 Mailing-List: contact dev-help@jackrabbit.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jackrabbit.apache.org Delivered-To: mailing list dev@jackrabbit.apache.org Received: (qmail 81765 invoked by uid 99); 8 Dec 2006 10:45:52 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 08 Dec 2006 02:45:52 -0800 X-ASF-Spam-Status: No, hits=0.0 required=10.0 tests= X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO brutus.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 08 Dec 2006 02:45:43 -0800 Received: from brutus (localhost [127.0.0.1]) by brutus.apache.org (Postfix) with ESMTP id 575887142FB for ; Fri, 8 Dec 2006 02:45:22 -0800 (PST) Message-ID: <25413495.1165574722354.JavaMail.jira@brutus> Date: Fri, 8 Dec 2006 02:45:22 -0800 (PST) From: "Jan Kuzniak (JIRA)" To: dev@jackrabbit.apache.org Subject: [jira] Updated: (JCR-97) Improve Checkstyle conformance MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-Virus-Checked: Checked by ClamAV on apache.org [ http://issues.apache.org/jira/browse/JCR-97?page=all ] Jan Kuzniak updated JCR-97: --------------------------- Attachment: jackrabbitCoreFsDbCleanup.patch org.apache.jackrabbit.core.fs.db package cleared. Only javadoc errors are left. I suggest changing line length module of the checkstyle.xml that it works better with javadocs. It can be achieved with this configuration: It allows javadoc lines with one long word (e.g. XML code) to exceed 80 characters. > Improve Checkstyle conformance > ------------------------------ > > Key: JCR-97 > URL: http://issues.apache.org/jira/browse/JCR-97 > Project: Jackrabbit > Issue Type: Improvement > Reporter: Jukka Zitting > Priority: Minor > Attachments: jackrabbitAPICheckstylePatch.patch, jackrabbitCoreClusterCleanup.patch, jackrabbitCoreConfigCleanup.patch, jackrabbitCoreFsDbCleanup.patch, jackrabbitCoreUnnecessaryCodeCleanup.patch > > > This is an ongoing meta-issue for improving the Checkstyle conformance of the Jackrabbit codebase. > Checkstyle (http://checkstyle.sourceforge.net/) is an automated tool for checking conformance with coding standard and good coding style. A Checkstyle report for Jackrabbit can be generated by running "maven checkstyle". > Currently the Jackrabbit Checkstyle report contains thousands of trivial problems like unused imports and minor formatting issues. While it would be possible to just remove those checks from the Jackrabbit Checkstyle configuration, it would certainly be better to fix the real issues. After fixing the trivial problems, the Checkstyle reports become much more valuable tools in locating troublesome code and identifying chances for improvement. > While this issue remains open, you have an open mandate to improve the standards conformance and coding style of the Jackrabbit sources. This mandate applies only to changes that fix problems reported by Checkstyle while making no changes to the external interface or behaviour of the changed code. > The commit messages of such Checkstyle improvements should be labeled with the Jira key of this issue (JCR-97) to mark the changes as style-only. This way other committers will have easier time reviewing your changes for bugs or other unexpected side-effects. > If you are not a Jackrabbit committer, but want to help improve the Checkstyle conformance, you can make your changes using sources from anonymous subversion and send your changes as an attachment to this issue. Please see the Javadoc improvement issue JCR-73 for details. > PS. Blind conformance to style guides is seldom beneficial. Please remember that the goal of this issue is to improve Jackrabbit code, not just the Checkstyle output! -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira