You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geronimo.apache.org by "John Sisson (JIRA)" <de...@geronimo.apache.org> on 2005/12/02 02:48:30 UTC

[jira] Created: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Preserve comments added by users in the config.xml file
-------------------------------------------------------

         Key: GERONIMO-1265
         URL: http://issues.apache.org/jira/browse/GERONIMO-1265
     Project: Geronimo
        Type: Improvement
  Components: startup/shutdown, usability  
    Versions: 1.0-M5, 1.0    
    Reporter: John Sisson
     Fix For: 1.1


Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).

As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
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


[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Donald Woods (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12508547 ] 

Donald Woods commented on GERONIMO-1265:
----------------------------------------

1) Yes, the Schema version needs updating, which I'd vote for 1.2 to match similar version updates to the plugin schema version.
2) Yes, I would also like to see support for comments anywhere in the file

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 1.1.1, 1.1.2, 1.1.x, 1.2
>            Reporter: John Sisson
>             Fix For: 1.x, 2.0-M5
>
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12517117 ] 

Jay D. McHugh commented on GERONIMO-1265:
-----------------------------------------

Committed revision 561989

- Added new schema (see 3266)
- Added support for module level comments

Changes inspired by Don Hill's patch - Thanks Don!

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Matt Hogstrom (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/GERONIMO-1265?page=all ]

Matt Hogstrom updated GERONIMO-1265:
------------------------------------

        Fix Version/s: 1.x
                       2.0
                           (was: 1.2)
    Affects Version/s: 1.1.1
                       1.1
                       1.1.2
                       1.1.x
                       1.2

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: http://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.1.1, 1.0-M5, 1.0, 1.1, 1.1.2, 1.1.x, 1.2
>            Reporter: John Sisson
>             Fix For: 1.x, 2.0
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
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

        

[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Don Hill (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12507635 ] 

Don Hill commented on GERONIMO-1265:
------------------------------------

I submitted a patch with no comment, at least thats the way it looks, anyways the patch geronimo-1265 has a work around that will allow a user to add comments without losing them. I modified the schema 
 <xsd:complexType name="moduleType">
         <xsd:sequence>
+            <xsd:element name="comment" type="xsd:string" minOccurs="0" />
             <xsd:element name="gbean" type="atts:gbeanType" minOccurs="0"
                 maxOccurs="unbounded" />
         </xsd:sequence>

and added supporting code to org/apache/geronimo/system/configuration/ConfigurationOverride.java

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 1.1.1, 1.1.2, 1.1.x, 1.2
>            Reporter: John Sisson
>             Fix For: 1.x, 2.0-M5
>
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12543651 ] 

Jay D. McHugh commented on GERONIMO-1265:
-----------------------------------------

Committed revision 596403.

Here is a new set of changes that should hopefully finish fleshing out comment support in config.xml.

1) If there is no 'top level' comment in config.xml then a default warning comment will be inserted.  Once there is a comment, it will be retained.
2) If you include a comment element in the pom.xml file of a module at the GBean level, it will be carried over into the config.xml.
3) A comment added to config.xml at the module level will be retained.

Todo:
1) Figure out how a comment for the entire config.xml file can be placed into the source and make sure that it makes it to the final config.xml.
2) Figure out how  a comment for a full module (within) config.xml can be placed into the source and make sure it makes it to the final config.xml).

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12508389 ] 

Jay D. McHugh commented on GERONIMO-1265:
-----------------------------------------

I took a look at the patch and it does work as intended.

And, it would probably be a good start to including comments in the config.xml file.

But I'm thinking that if the schema is being updated then:
1) The version should get incremented (1.1 -> 1.2 or 1.1.1).
2) We should go ahead and add support to the schema to have comments at just about any location.

Does anyone else have any thoughts on the schema?

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 1.1.1, 1.1.2, 1.1.x, 1.2
>            Reporter: John Sisson
>             Fix For: 1.x, 2.0-M5
>
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jay D. McHugh updated GERONIMO-1265:
------------------------------------

             Assignee: Jay D. McHugh
    Affects Version/s:     (was: 1.2)
                           (was: 2.0-M7)
                       2.1

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jay D. McHugh closed GERONIMO-1265.
-----------------------------------


> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>             Fix For: 2.1
>
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jay D. McHugh updated GERONIMO-1265:
------------------------------------

    Affects Version/s:     (was: 1.1.2)
                           (was: 1.1.x)
                           (was: 1.1.1)
                       2.0-M7
        Fix Version/s:     (was: 2.0-M5)
                           (was: 1.x)

There is no current development being done on any version besides 1.2 and 2.0.

Remove 'affects' versions not being developed and clear 'fix' versions (should not be filled in until completed)

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 1.2, 2.0-M7
>            Reporter: John Sisson
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jay D. McHugh resolved GERONIMO-1265.
-------------------------------------

       Resolution: Fixed
    Fix Version/s: 2.1

No one has commented that they wanted the additional functionality that I had been holding this issue open for.

So I am closing it.  We can create a new JIRA or reopen this one later if anyone decides that we want that (or some other) comment functionality later.

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>             Fix For: 2.1
>
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (GERONIMO-1265) Preserve comments added by users in the config.xml file

Posted by "Jay D. McHugh (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GERONIMO-1265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12559176#action_12559176 ] 

Jay D. McHugh commented on GERONIMO-1265:
-----------------------------------------

After considering this some more - I don't think it is necessary for us to be able to do either of the 'todo' items above (especially not #1).

Comments are retained for each level of the config.xml file.

And if they are added to the pom.xml's in source (in the '<config-xml-content>' section) then they are carried into the generated config.xml for the server.

Is there anyone who specifically wants to be able to do either of the 'todo' items above?

If not, then I am going to go ahead and close this issue.

> Preserve comments added by users in the config.xml file
> -------------------------------------------------------
>
>                 Key: GERONIMO-1265
>                 URL: https://issues.apache.org/jira/browse/GERONIMO-1265
>             Project: Geronimo
>          Issue Type: Improvement
>      Security Level: public(Regular issues) 
>          Components: startup/shutdown, usability
>    Affects Versions: 1.0-M5, 1.0, 1.1, 2.1
>            Reporter: John Sisson
>            Assignee: Jay D. McHugh
>         Attachments: geronimo-1265.patch
>
>
> Currently if a user adds comments to the config.xml file, they will be lost when Geronimo re-generates the file if a configuration change is made (e.g. through the web console).
> As a temporary measure, the code that re-generates the XML will place a warning at the top of the file warning users not to place comments in it.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.