Return-Path: Delivered-To: apmail-geronimo-dev-archive@www.apache.org Received: (qmail 13676 invoked from network); 25 Feb 2007 06:34:28 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 25 Feb 2007 06:34:28 -0000 Received: (qmail 25507 invoked by uid 500); 25 Feb 2007 06:34:35 -0000 Delivered-To: apmail-geronimo-dev-archive@geronimo.apache.org Received: (qmail 25447 invoked by uid 500); 25 Feb 2007 06:34:35 -0000 Mailing-List: contact dev-help@geronimo.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: dev@geronimo.apache.org List-Id: Delivered-To: mailing list dev@geronimo.apache.org Received: (qmail 25436 invoked by uid 99); 25 Feb 2007 06:34:35 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 24 Feb 2007 22:34:35 -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; Sat, 24 Feb 2007 22:34:25 -0800 Received: from brutus (localhost [127.0.0.1]) by brutus.apache.org (Postfix) with ESMTP id 9555371403D for ; Sat, 24 Feb 2007 22:34:05 -0800 (PST) Message-ID: <22664106.1172385245593.JavaMail.jira@brutus> Date: Sat, 24 Feb 2007 22:34:05 -0800 (PST) From: "Christopher M. Cardona (JIRA)" To: dev@geronimo.apache.org Subject: [jira] Commented: (GERONIMO-2661) Make geronimo schema files more human readable In-Reply-To: <24637857.1166079141012.JavaMail.jira@brutus> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-Virus-Checked: Checked by ClamAV on apache.org [ https://issues.apache.org/jira/browse/GERONIMO-2661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12475701 ] Christopher M. Cardona commented on GERONIMO-2661: -------------------------------------------------- Applied the alldoc.patch to trunk rev. 511458 with additional modifications: - Removed the extra Apache license annotation (I think the original Apache license header is enough) - Arranged the schema formatting - Changed some annotation/documentation text Thanks Rakesh! > Make geronimo schema files more human readable > ---------------------------------------------- > > Key: GERONIMO-2661 > URL: https://issues.apache.org/jira/browse/GERONIMO-2661 > Project: Geronimo > Issue Type: Improvement > Security Level: public(Regular issues) > Components: documentation > Affects Versions: 2.0 > Environment: Any > Reporter: Rakesh Midha > Assigned To: Christopher M. Cardona > Priority: Minor > Fix For: 2.0 > > Attachments: alldoc.patch, appclientdoc.patch, appdoc.patch, attributedoc.patch, connectordoc.patch, jettyconfigdoc.patch, jettydoc.patch, logindoc.patch, moduledoc.patch, namingdoc.patch, plugindoc.patch, securitydoc.patch, tomcatconfigdoc.patch, tomcatdoc.patch, webdoc.patch > > > Geronimo schema files are the files which are basically exposed to all the user's to follow the guidelines while developing there plan files. These schema files should have lot of documentation just like j2ee descriptor's schema's. All the fields should be described. > Schema formatting provides a nice option to do this by specifying > > documentation for each element goes here > > for each and every element in schema files. > I think this will make it more human readable, i believe that every file which is openly exposed to user's should have lot of documentation for readbility. What do you think? -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.