Bug 497251

Summary: Review Request: libstdc++-docs - Documentation in html for libstdc++
Product: [Fedora] Fedora Reporter: Benjamin Kosnik <bkoz>
Component: Package ReviewAssignee: Susi Lehtola <susi.lehtola>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: atorkhov, fedora-package-review, jakub, mnewsome, notting, susi.lehtola
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: 2009-05-15 16:10:29 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:
Attachments:
Description Flags
gcc.spec patch for libstdc++-devel doc enhancements
none
patch 1
none
patch 2
none
gcc.spec file with libstdc++-devel doc enhancements none

Description Benjamin Kosnik 2009-04-23 00:35:59 UTC
Spec URL: http://people.redhat.com/bkoz/documentation/libstdc++-docs.spec
SRPM URL: http://people.redhat.com/bkoz/documentation/libstdc++-docs-4.4.0-1.fc10.src.rpm
Description: 
The libstdc++-docs package contains documentation for the GNU C++ library.

Included are three components: the manual, doxygen-generated API
information for all files, namespaces and entities, and the frequently
asked questions list. All documentation is provided in html format.

Comment 1 Benjamin Kosnik 2009-04-23 00:39:27 UTC
The man pages could be added to this. These are the man pages:

ftp://gcc.gnu.org/pub/libstdc++/doxygen/libstdc++-man.4.4.0.tar.bz2

Comment 2 Susi Lehtola 2009-04-23 06:38:29 UTC
- The lines
 Obsoletes: libstdc++-docs <= 4.3.0
 Provides: libstdc++-docs = %{version}-%{release}
since they are redundant.

- Please remove the empty %check section.

- Use %{version} in the Source lines and in the %{build} phase.


Once you have added the man pages, I will perform the review.

Comment 3 Jakub Jelinek 2009-04-23 06:43:20 UTC
Isn't all this generated from gcc sources?  What is needed to generate it?  Just doxygen?
If yes I'd say it would be better to ship this as subpackages of gcc, guarded by some spec macro that those who initially bootstrap gcc in a rpm based distro could turn off, so that gcc build doesn't require doxyen.

Comment 4 Susi Lehtola 2009-04-23 07:23:03 UTC
(In reply to comment #3)
> Isn't all this generated from gcc sources?  What is needed to generate it? 
> Just doxygen?
> If yes I'd say it would be better to ship this as subpackages of gcc, guarded
> by some spec macro that those who initially bootstrap gcc in a rpm based distro
> could turn off, so that gcc build doesn't require doxyen.  

Yeah, this package should be part of the gcc package, since libstdc++ is also generated in the gcc srpm.

Comment 5 Benjamin Kosnik 2009-04-24 18:31:46 UTC
I've updated this here:
http://people.redhat.com/bkoz/documentation/

This adds the man packages. This essentially duplicates some of the libstdc++-devel package (html), and so should probably be integrated into that. Jakub, your call.

Here are the dependencies:

1) for api html docs:
doxygen, graphviz

2) for manual html docs:
libxslt, libxml2, docbook-style-xsl

3) for manual pdf:
prince, msttfonts


To eliminate the deps for 2, use the pre-generated libstdc++-v3/doc/html directory in the gcc sources.

To eliminate the deps for 1, use the pre-generated files on gcc.gnu.org.

Comment 6 Benjamin Kosnik 2009-04-28 22:19:56 UTC
Created attachment 341659 [details]
gcc.spec patch for libstdc++-devel doc enhancements


This plus the small patches also attached will generate the doxygen html and man pages for libstdc++-devel. This is configurable via the build_libstdcxx_docs switch in gcc.spec. 

This seems like the way to go, all is ok except that the man pages are not installed in /user/share/man/* but instead in /user/share/docs/libstdc++-devel/.

Not quite sure what is going on there.

Comment 7 Benjamin Kosnik 2009-04-28 22:20:34 UTC
Created attachment 341660 [details]
patch 1

Comment 8 Benjamin Kosnik 2009-04-28 22:20:55 UTC
Created attachment 341661 [details]
patch 2

Comment 9 Benjamin Kosnik 2009-04-28 22:21:34 UTC
Created attachment 341662 [details]
gcc.spec file with libstdc++-devel doc enhancements

Comment 10 Benjamin Kosnik 2009-04-29 18:13:22 UTC
Jakub, I've done this both ways: as maintainer of gcc.spec, can you pick what you want? My suggestion is to mod libstdc++-devel.

Comment 11 Benjamin Kosnik 2009-05-05 18:35:21 UTC
Ping. Can this get merged into the gcc-4.4.0 rpms on the next respin please?

Comment 12 Jakub Jelinek 2009-05-06 13:33:34 UTC
Benjamin, can you please look at
http://koji.fedoraproject.org/scratch/jakub/task_1338267/
and say if that's what you want or not?
If so, I'll do a real build soon.
All I found so far is that I need to remove all *~ files from the html directory.

Comment 13 Susi Lehtola 2009-05-15 16:10:29 UTC
This seems to be merged, closing.

Comment 14 Alexey Torkhov 2009-05-31 09:09:34 UTC
*** Bug 451619 has been marked as a duplicate of this bug. ***