This is the mail archive of the systemtap@sourceware.org mailing list for the systemtap project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Bug documentation/11077] New: URLs in the HTML documentation are not meaningful


Looking up information in the online documentation, I see URL fragments like 
this:
http://sourceware.org/systemtap/langref/node6.html#SECTION000612000000000000000

These URLs are not human-readable, and are fragile; they will change when new 
content is added above them in the source file.

The above URL would be better as something like:
http://sourceware.org/systemtap/langref/ProbePoints.html#PointerTypecasting

This would be human-readable, more robust in the face of editing, and be more 
likely to show up in search engines.

It looks like you're using DocBook to generate these docs.  I think you can fix 
this by adding "id" attributes to the relevant <section> tags.

-- 
           Summary: URLs in the HTML documentation are not meaningful
           Product: systemtap
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: documentation
        AssignedTo: systemtap at sources dot redhat dot com
        ReportedBy: dmalcolm at redhat dot com


http://sourceware.org/bugzilla/show_bug.cgi?id=11077

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]