Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 919240 - x11-wm/fvwm3-1.0.8:0 - Man pages are not generated by default
Summary: x11-wm/fvwm3-1.0.8:0 - Man pages are not generated by default
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal minor
Assignee: Matt Jolly
URL:
Whiteboard:
Keywords: PullRequest
Depends on:
Blocks:
 
Reported: 2023-12-04 21:48 UTC by Zach Tuttle
Modified: 2023-12-20 19:42 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Zach Tuttle 2023-12-04 21:48:15 UTC
I was talking with some of the developers in IRC channel in #fvwm, and I was asking why man pages are not generated by default, and essentially said it was dependent for each distro. which lead me to look the source for the fvwm3 ebuild and I noticed we enable man pages in the ebuild's src_configure function:	

$(use_enable doc mandoc)

but according to the developers of fvwm3 we need to explicitly pass in:

--enable-mandoc
Comment 1 Alfred Wingate 2023-12-04 22:11:06 UTC
$(use_enable doc mandoc) turns into --enable-mandoc if doc use flag is enabled or --disable-mandoc is doc use flag is disabled. 

I guess this could be a bug if the mandoc switch only builds man pages, in which case the use flag is misleading.

Seeing that mandoc is very light enabling the use flag by default shouldn't be a big deal.

https://projects.gentoo.org/qa/policy-guide/installed-files.html#pg0305
Comment 2 Zach Tuttle 2023-12-05 15:30:25 UTC
When installing I simply ran `emerge -a x11-wm/fvwm3` command with no extra flags set.

These are the USE flags on my system that were used with fvwm3

$ equery u fvwm3
[ Legend : U - final flag setting for installation]
[        : I - package is installed with flag     ]
[ Colors : set, unset                             ]
 * Found these USE flags for x11-wm/fvwm3-1.0.8:
 U I
 - - bidi                            : Enable bidirectional language support
 - - debug                           : Enable extra debug codepaths, like asserts and extra output. If you want to get
                                       meaningful backtraces see
                                       https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces
 - - doc                             : Add extra documentation (API, Javadoc, etc). It is recommended to enable per
                                       package instead of globally
 + + go                              : Enable building dev-lang/go code (FvwmPrompt)
 - - lock                            : Enable screen locking
 - - netpbm                          : Enable NetPBM support (used by FvwmScript-ScreenDump)
 + + nls                             : Add Native Language Support (using gettext - GNU locale utilities)
 - - perl                            : Add optional support/bindings for the Perl language
 - - python_single_target_python3_10 : Build for Python 3.10 only
 + + python_single_target_python3_11 : Build for Python 3.11 only
 - - python_single_target_python3_12 : Build for Python 3.12 only
 + + readline                        : Enable support for libreadline, a GNU line-editing library that almost everyone
                                       wants
 - - stroke                          : Mouse Gesture support
 + + svg                             : Add support for SVG (Scalable Vector Graphics)
 - - tk                              : Add support for Tk GUI toolkit
Comment 3 Zach Tuttle 2023-12-06 17:41:56 UTC
In the current ebuild branch for fvwm3 it currently has two ebuild files
 * fvwm3-1.0.8.ebuild
 * fvwm3-9999.ebuild


In fvwm3-1.0.8.ebuild in the source configure we have both man page options explicitly set: --enable-mandoc & --enable-htmldoc
Comment 4 Matt Jolly gentoo-dev 2023-12-09 18:56:22 UTC
Thanks. Oversight - Man pages should always be installed.
Comment 5 Larry the Git Cow gentoo-dev 2023-12-13 02:06:05 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=7f70474f00e0250861d24f0230144feb317c4938

commit 7f70474f00e0250861d24f0230144feb317c4938
Author:     Matt Jolly <Matt.Jolly@footclan.ninja>
AuthorDate: 2023-12-09 19:05:15 +0000
Commit:     Sam James <sam@gentoo.org>
CommitDate: 2023-12-13 02:05:07 +0000

    x11-wm/fvwm3: add 1.0.9
    
    Fix man installation which was unintentionally disabled
    alongside htmldoc.
    
    Add pregenerated docs to avoid pulling in
    ruby as a bdep.
    
    Closes: https://bugs.gentoo.org/919240
    Signed-off-by: Matt Jolly <Matt.Jolly@footclan.ninja>
    Closes: https://github.com/gentoo/gentoo/pull/34200
    Signed-off-by: Sam James <sam@gentoo.org>

 x11-wm/fvwm3/Manifest           |   2 +
 x11-wm/fvwm3/fvwm3-1.0.9.ebuild | 203 ++++++++++++++++++++++++++++++++++++++++
 x11-wm/fvwm3/fvwm3-9999.ebuild  |  51 ++++++++--
 3 files changed, 248 insertions(+), 8 deletions(-)