Bugzilla – Bug 151370
yast2-ncurses carries 14MB documentation
Last modified: 2006-02-21 17:02:11 UTC
the content of /usr/share/doc/packages/yast2-ncurses/autodocs/ looks like doxygen documentation. do we really need those on any installed system? [[[ # rpm -qlv yast2-ncurses | grep -v '/usr/share/doc/packages/yast2-ncurses/autodocs/' -rw-r--r-- 1 root root 1188 Jan 31 07:41 /usr/lib64/YaST2/plugin/libpy2ncurses.la lrwxrwxrwx 1 root root 22 Jan 31 07:41 /usr/lib64/YaST2/plugin/libpy2ncurses.so -> libpy2ncurses.so.2.0.0 lrwxrwxrwx 1 root root 22 Jan 31 07:41 /usr/lib64/YaST2/plugin/libpy2ncurses.so.2 -> libpy2ncurses.so.2.0.0 -rwxr-xr-x 1 root root 1624592 Jan 31 07:42 /usr/lib64/YaST2/plugin/libpy2ncurses.so.2.0.0 -rw-r--r-- 1 root root 6160 Jan 24 2005 /usr/share/YaST2/data/pkg_layout.ycp -rw-r--r-- 1 root root 2988 Jan 24 2005 /usr/share/YaST2/data/you_layout.ycp drwxr-xr-x 2 root root 0 Jan 31 07:42 /usr/share/doc/packages/yast2-ncurses -rw-r--r-- 1 root root 17992 Jan 24 17:00 /usr/share/doc/packages/yast2-ncurses/COPYING -rw-r--r-- 1 root root 17992 Jan 24 17:00 /usr/share/doc/packages/yast2-ncurses/COPYRIGHT.english -rw-r--r-- 1 root root 79 Jan 24 17:00 /usr/share/doc/packages/yast2-ncurses/README drwxr-xr-x 2 root root 0 Jan 31 07:42 /usr/share/doc/packages/yast2-ncurses/autodocs ]]] that makes 1.7MB code and 14MB api documentation. maybe we should move the documentation into a subpackage.
Such a split is ok with me.
OK. How about qt? The ratio is not as bad there though.
yast2-qt or qt in general?:) if you refer to yast-qt ... for the sake of consistency ... i would say split it aswell.
I would say we have a zillion better things to do right now. AFAIK snwint kicks out unneeded stuff from the inst-sys anyway.
Exactly. Feel free to write terabytes of documentation.
i dont have any problems doing the few spec file changes on my own. i just wanted an OK from you. so if you are fine with it. i will submit packages with split of documentation and do the PDB changes. fine with you?
sure, thanks :)
1a2,7 > Fri Feb 17 13:46:16 CET 2006 - mrueckert@suse.de > > - split the doxygen docs into their own package. > yast2-ncurses-devel-docs > > ------------------------------------------------------------------- running check_dates_in_changes performing spec file checks . yast2-ncurses: Group is System/YaST ...ok yast2-ncurses-devel-docs: Group is System/YaST ...ok Ok. Remember to have fun...
From suse-dist: This does not make any sense, the docu generated is useful only for the yast2-ncurses developer. This is not a development lib. The generated doxygen HTML should not be packaged at all.
Stefan, what about yast2-qt?
i have a splitted version of this package too. i can just submit this package aswell if you want.
I tend to agree with Stano that this documentation is only useful for programming the UI (as opposed to programming _with_ the UI, i.e., write YCP dialogs) anyway. We should not package it to begin with. Those who want to extend the UI need the sources anyway, and all those docs are auto-generated from the sources.
Martin, please, fix it on one of the next submits. Thanks!
I found that unfortunately Automake doesn't support noinst_DATA (as opposed to noinst_PROGRAMS, noinst_LIBS), so the only way to not build and distribute that is to omit "autodocs" from "SUBDIRS" in doc/Makefile.am . As an added benefit, you don't have to wait all the time until all that HTML gets generated and installed.
What about defining generating as a special target to be invoked manually?
Please also remove the autodocs of the other yast modules. On my Suse 10.0 default install I have a total of 26MB of useless autodocs from yast in 53 directories.
OK, I will remove the docs from yast2-ncurses and drop yast2-ncurses-devel-docs. Marcus, sorry for the extra work, I did not realize it before. Comment 16: The autodocs are indeed useful only in yast2-core, other C++ packages blindly copied its packaging style without realizing that they export no API to document. All C++ packages should be changed to use a unified automake include file that will generate the autodocs on a manual target (coment 15). Comment 14: Of course, because data that is not installed is useless (and only consumes build power), as opposed to not installed programs (which may be used to generate installed data).
yast2-ncurses-2.13.9 no longer has the autodocs. yast2-devtools-2.13.9 provides a simple way for the maintainers to do the same in their packages.
Did the same for yast2-qt.