You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by bu...@apache.org on 2017/06/26 05:38:46 UTC

[Bug 61223] New: Enhance the documentation for mbeans-descriptors.xml

https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

            Bug ID: 61223
           Summary: Enhance the documentation for mbeans-descriptors.xml
           Product: Tomcat 9
           Version: unspecified
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
          Assignee: dev@tomcat.apache.org
          Reporter: alexis.hassler@sewatech.fr
  Target Milestone: -----

The documentation
(https://tomcat.apache.org/tomcat-9.0-doc/mbeans-descriptors-howto.html) does
not describe the attributes of each mbean.

Something similar to the comments in mbeans-descriptors.dtd would be useful.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

--- Comment #6 from Mark Thomas <ma...@apache.org> ---
The patch file provided is not in diff -u format. I'd expect it to look like
this:
http://people.apache.org/~markt/patches/applied/2008-10-30-bug44494-regression.patch

I'll also repeat my recommendation from comment #4

I suggest you try building the documentation and reviewing the output. It isn't
going to be what you think it is.

To be explicit, the format of the proposed change is broken. The rules for
rendering whitespace in HTML mean that there will be a single block of
unformatted text - not the table you intend.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Mark Thomas <ma...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |Beginner
           Severity|normal                      |enhancement

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Mark Thomas <ma...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEEDINFO                    |NEW

--- Comment #4 from Mark Thomas <ma...@apache.org> ---
Restore state to the correct value. NEEDINFO is used when more information is
required from the OP which is not the case here.

Patches should be provided in diff -u format.

I also suggest you try building the documentation and reviewing the output. It
isn't going to be what you think it is.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Mark Thomas <ma...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |FIXED

--- Comment #7 from Mark Thomas <ma...@apache.org> ---
In the end, I opted to simple copy the DTD to the docs and provide a link. I
thought that was better then duplicating large sections of the comments from
the DTD.

Fixed in:
- trunk for 9.0.3 onwards
- 8.5.x for 8.5.25 onwards
- 8.0.x for 8.0.49 onwards
- 7.0.x for 7.0.84 onwards

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


RE: [Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by Kapil Kumar <ka...@gmail.com>.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Updated patch file for individual file as suggested.

Could you please give me something else to work upon.


Regards
Kapil Kumar

-----Original Message-----
From: bugzilla@apache.org [mailto:bugzilla@apache.org] 
Sent: 05 नवम्बर 2017 22:12
To: dev@tomcat.apache.org
Subject: [Bug 61223] Enhance the documentation for mbeans-descriptors.xml

https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

--- Comment #5 from Kapil <ka...@gmail.com> --- Created attachment 35489
  --> https://bz.apache.org/bugzilla/attachment.cgi?id=35489&action=edit
Updated patch file for individual file as suggested.

Updated patch file for individual file as suggested.

--
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org For additional commands, e-mail: dev-help@tomcat.apache.org



---
This email has been checked for viruses by Avast antivirus software.
https://www.avast.com/antivirus


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

--- Comment #5 from Kapil <ka...@gmail.com> ---
Created attachment 35489
  --> https://bz.apache.org/bugzilla/attachment.cgi?id=35489&action=edit
Updated patch file for individual file as suggested.

Updated patch file for individual file as suggested.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

--- Comment #1 from Kapil <ka...@gmail.com> ---
the MBeans Descriptors How To xml file has been updated.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

--- Comment #2 from Mark Thomas <ma...@apache.org> ---
You need to attach a patch with your updates to this bug report for review.

http://www.apache.org/dev/contributors.html#patches

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Kapil <ka...@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |kap.kumar88@gmail.com

--- Comment #3 from Kapil <ka...@gmail.com> ---
Created attachment 35469
  --> https://bz.apache.org/bugzilla/attachment.cgi?id=35469&action=edit
Updated mbeans-descriptors-howto.xml

Updated mbeans-descriptors-howto.xml

Hope this helps, let me know for any further refinements, suggestions,
recommendations.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[Bug 61223] Enhance the documentation for mbeans-descriptors.xml

Posted by bu...@apache.org.
https://bz.apache.org/bugzilla/show_bug.cgi?id=61223

Kapil <ka...@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |NEEDINFO

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org