1:51 a.m.
Tom Jenkinson created JBTM-1116:
-----------------------------------
Summary: Document properties
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public (Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Tom Jenkinson
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
1:51 a.m.
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Fix Version/s: 5.0.0.Final
Document properties
-------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Tom Jenkinson
Fix For: 5.0.0.Final
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
4 a.m.
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Assignee: Michael Musgrove (was: Tom Jenkinson)
Document properties
-------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Michael Musgrove
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:10 a.m.
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Michael Musgrove updated JBTM-1116:
-----------------------------------
Assignee: Gytis Trikleris (was: Michael Musgrove)
Document properties
-------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:20 a.m.
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Jonathan Halliday commented on JBTM-1116:
-----------------------------------------
We dropped the docs on purpose, as they kept getting out of sync and being misleading. In
the case of the properties file, putting in all properties, their docs and defaults made
it harder to find the small number of important properties that do need setting (e.g. node
id) and gave the user way too many opportunities to break things. The only properties
reference is now the javadoc on the bean classes. We did mull over generating or linking
the docs to/from the javadoc, but never got around to the necessary tooling.
Document properties
-------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:46 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Summary: Document configuration (was: Document properties)
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:46 a.m.
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson commented on JBTM-1116:
-------------------------------------
Good points, lets rework this Jira as an opportunity to simply:
1. Ensure the Javadocs in isolation are still correct, fully explained
2. Ensure the documentation explains the architecture of our configuration mechanism
3. Ensure the documentation builds on point 2 to reference the relevant beans when
configuring common deployment scenarios, e.g. which properties do you need to enable
hornetq/JDBC object store
Document properties
-------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:46 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Assignee: Tom Jenkinson (was: Gytis Trikleris)
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Tom Jenkinson
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
6:18 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Assignee: Gytis Trikleris (was: Tom Jenkinson)
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
6:24 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson commented on JBTM-1116:
-------------------------------------
Hi Gytis,
Initially please can you go through *EnvironmentBean.java and check that the configuration
is still in use ("find usages" and if not, mark it as @deprecated. Also make
sure that all getters and setters are documented in the javadoc.
Alongside that, although it somewhat contradicts the idea of not documenting the beans in
the docs, please can you take an inventory of which configuration items are mentioned in
the docs, and where. It may be that these should be removed if they are too low-level and
instead to rework the docs to reference the beans at that point.
This will be useful for you to get to know some of the options that are available to JBTM
anyway. Also, please can you make sure that each *EnvironmentBean is documented at the
class level to describe its purpose. I will give you an example of potentially confusing,
ObjectStoreEnvironmentBean. It has configuration for multiple types of object store which
only apply to certain object stores, we should somehow ensure it is clear if the bean
configuration can be used for multiple purposes, which properties apply to which purpose
(at a coarse level, e.g. CacheStore vs ShadowStore).
Please can you ask me to review your pull request (do this via this Jira by linking the
pull req) so I can take a look over it.
Also, please don't reformat the code, or move the beans properties around, just add to
them or subtract from them. I am sure there will be a temptation to reformat the class to
make the related entries closer but this is harder to isolate the changes.
Thanks,
Tom
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
6:24 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Tom Jenkinson updated JBTM-1116:
--------------------------------
Priority: Minor (was: Major)
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Priority: Minor
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
7:24 a.m.
New subject: [JBoss JIRA] (JBTM-1116) Document configuration
[
https://issues.jboss.org/browse/JBTM-1116?page=com.atlassian.jira.plugin....
]
Work on JBTM-1116 started by Gytis Trikleris.
Document configuration
----------------------
Key: JBTM-1116
URL: https://issues.jboss.org/browse/JBTM-1116
Project: JBoss Transaction Manager
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Documentation
Reporter: Tom Jenkinson
Assignee: Gytis Trikleris
Priority: Minor
Fix For: 5.0.0.M3
In the pre-Bean days of setting properties, we had all of the TS properties called out in
a properties.xml file. In that file there were copious comments to say what the property
was for and whether it should be changed. We also documented these properties in the docs.
It seems from some investigation that Mike and I have done today that the migration away
from the properties file to using MBeans has removed those comments and the docs for the
properties. Sometimes the comments do appear in the code.
If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA)
then look in the etc directories.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
4376
days inactive
4613
days old
jbossts-issues@lists.jboss.org
11 comments
4 participants
participants (4)
-
Gytis Trikleris (JIRA) -
Jonathan Halliday (JIRA)
-
Michael Musgrove (JIRA)
-
Tom Jenkinson (JIRA)