Bug 470453

Summary: Java VisualVM integration paragraphs looks weird
Product: [Retired] Fedora Documentation Reporter: Mark Wielaard <mjw>
Component: release-notesAssignee: Release Notes Tracker <relnotes>
Status: CLOSED UPSTREAM QA Contact: Karsten Wade <kwade>
Severity: urgent Docs Contact:
Priority: urgent    
Version: devel   
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-11-07 11:32:18 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 151189    

Description Mark Wielaard 2008-11-07 09:45:33 UTC
http://docs.fedoraproject.org/release-notes/f10preview/en_US/How_are_Things_for_Developers.html#sn-New_integration_with_other_Fedora_technologies

The section on VisualVM integration looks strange, the program name between brackets (jvisualvm) is put on its own line. The XML has:

   <section id="sn-VisualVM_integration_through_the_NetBeans_framework">
      <title>VisualVM integration through the NetBeans framework</title>
      <para>VisualVM (<programlisting
          format="linespecific">jvisualvm</programlisting>) provides a
        graphical overview of any local or remotely running Java
        application, letting you monitor all running threads, classes,
        and objects allocated by the application by taking thread dumps,
        heap dumps, and other lightweight profiling tools.</para>
    </section>

The programlisting tag should be a filename tag (and shouldn't have a format attribute so that it the sentence is all on the same line.

Comment 1 Karsten Wade 2008-11-07 11:32:18 UTC
That's leftover markup from the wiki2xml conversion process, missed in the manual stage of that conversion, thanks for the catch.  Rather than being <filename/>, I think that is either <command/> or <package/>; I went for the former based on context.