Bug 543481 - Unsubstituted Docbook parameters in git manpages
Summary: Unsubstituted Docbook parameters in git manpages
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: git
Version: 12
Hardware: All
OS: Linux
low
low
Target Milestone: ---
Assignee: Todd Zullinger
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2009-12-02 14:11 UTC by Michal Schmidt
Modified: 2013-01-10 10:37 UTC (History)
5 users (show)

Fixed In Version: 1.6.6-1.fc12
Clone Of:
Environment:
Last Closed: 2010-01-19 19:44:16 UTC
Type: ---
Embargoed:


Attachments (Terms of Use)

Description Michal Schmidt 2009-12-02 14:11:10 UTC
Description of problem:
git's manpages refer to other documents, but with nonsense URLs. See for example 'man git', in section NOTES:

        1. Everyday Git
           [set $man.base.url.for.relative.links]/everyday.html

man.base.url.for.relative.links comes from Docbook.

Version-Release number of selected component (if applicable):
git-1.6.5.2-1.fc12.x86_64

How reproducible:
always

Steps to Reproduce:
rpm -ql git | grep '/usr/share/man' | xargs zgrep 'man\.base\.url'
  
Actual results:
Finds 21 occurences of the string.

Expected results:
Should find nothing as the parameter should be substituted for a real URL.

Comment 1 Todd Zullinger 2009-12-02 15:05:36 UTC
I see this all the way back to 1.6.0.6 in F-10 (and probably further, I just didn't check older packages).  It's also present in the man pages that upstream builds.

I'll see if I can find where in the dark reaches of the asciidoc/docbook chain this needs to be set and/or talk to upstream about it.

Comment 2 Todd Zullinger 2009-12-02 16:30:57 UTC
It's almost funny that the docbook documentation on man.base.url.for.relative.links¹ uses git in the example:

    For example:

    <xsl:param name="man.base.url.for.relative.links"
            >http://www.kernel.org/pub/software/scm/git/docs/</xsl:param>

I'll chat with upstream about adding this somewhere appropriate in the build process.  It's a dead simple thing to add if we hard code the URL, but better will be to have it configurable so that when we build our packages we can set the base URL to file://%{_docdir}/%{name}-%{version}/.

¹ http://docbook.xml-doc.org/snapshots/xsl/doc/manpages/man.base.url.for.relative.links.html

Comment 3 Fedora Update System 2010-01-03 01:50:05 UTC
git-1.6.6-1.fc12 has been submitted as an update for Fedora 12.
http://admin.fedoraproject.org/updates/git-1.6.6-1.fc12

Comment 4 Fedora Update System 2010-01-03 20:59:49 UTC
git-1.6.6-1.fc12 has been pushed to the Fedora 12 testing repository.  If problems still persist, please make note of it in this bug report.
 If you want to test the update, you can install it with 
 su -c 'yum --enablerepo=updates-testing update git'.  You can provide feedback for this update here: http://admin.fedoraproject.org/updates/F12/FEDORA-2010-0105

Comment 5 Mitchell Berger 2010-01-14 00:41:20 UTC
This bug also affects the version of git in F11 (specifically,
1.6.2.5-1.fc11).  I see that a package with 1.6.6 is in testing
for F12, and there are some desirable new features in 1.6.6.
Would it be possible to build git 1.6.6 for F11 as well?

Comment 6 Todd Zullinger 2010-01-14 03:52:49 UTC
Yep, I was planning to prepare an update for F-11 (and EL-5).  I'll try to get on that sooner rather than later.

Comment 7 Fedora Update System 2010-01-19 19:44:11 UTC
git-1.6.6-1.fc12 has been pushed to the Fedora 12 stable repository.  If problems still persist, please make note of it in this bug report.

Comment 8 Mitchell Berger 2010-04-16 07:52:33 UTC
(In reply to comment #6)
> Yep, I was planning to prepare an update for F-11 (and EL-5).  I'll try to get
> on that sooner rather than later.    

It's been over 3 months since this comment.  The git in F11 is
still affected by this bug, and at this point git 1.7 is available.
Please update git in F11.


Note You need to log in before you can comment on or make changes to this bug.