Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Man page fvwm3.1 not built by default #246

Closed
djwf opened this issue Oct 10, 2020 · 5 comments
Closed

Man page fvwm3.1 not built by default #246

djwf opened this issue Oct 10, 2020 · 5 comments
Labels
type:bug Something's broken!

Comments

@djwf
Copy link
Contributor

djwf commented Oct 10, 2020

When making and installing fvwm3 from the git repository, using the following commands, the file fvwm3.1 is not built or installed.

./autogen.sh
./configure
make
make install

This is unexpected given the first sentence of the second paragraph in doc/README: "By default, only the man page is generated."

If I add --enable-mandoc to the configure command, and run the commands below, then the fvwm3.1 file is created.

./autogen.sh
./configure --enable-mandoc
make
make install

This behavior may be intentional, and I figured I'd check before submitting a PR to fix either the README or the Makefile.am.

So: is the behavior intentional?
@issue-label-bot issue-label-bot bot added the type:bug Something's broken! label Oct 10, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label bug to this issue, with a confidence of 0.71. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@ThomasAdam
Copy link
Member

Hi @djwf

Hehe! Thanks for your eagie eyes! It's deliberate, and the README is wrong. Please submit a PR. Documentation is now opt-in.

Kindly,
Thomas

@djwf
Copy link
Contributor Author

djwf commented Oct 10, 2020

Got it - so should all the man pages be omitted by default? Or just the main page? I ask to figure out what should be in the PR.

@ThomasAdam
Copy link
Member

Hi @djwf

It's technically just the main fvwm3 page as that's what is built via the snake which is docbook.

I wouldn't draw a distinction though, I'd rather the PR just removed the assumption that manages are built for free.

@djwf
Copy link
Contributor Author

djwf commented Oct 10, 2020

Got it, PR will be inbound shortly!

@djwf djwf mentioned this issue Oct 10, 2020
Merged
djwf added a commit to djwf/fvwm3 that referenced this issue Oct 10, 2020
@djwf
Revise doc/README - docs not built by default
4a84373 
Fixes fvwmorg#246
djwf added a commit to djwf/fvwm3 that referenced this issue Oct 10, 2020
@djwf
Revise doc/README - docs not built by default
c438d3b 
The doc/README file stated that the man pages was built by default.
However, the man page is not built by default by intent, and all
documentation will (in fvwm3) become opt-in. Given that, revise the
doc/README to match the intended behavior: no documentation built by
default.

Fixes fvwmorg#246
mikeandmore pushed a commit to mikeandmore/fvwm3 that referenced this issue Nov 28, 2020
@djwf @mikeandmore
Revise doc/README - docs not built by default
ebd322c 
The doc/README file stated that the man pages was built by default.
However, the man page is not built by default by intent, and all
documentation will (in fvwm3) become opt-in. Given that, revise the
doc/README to match the intended behavior: no documentation built by
default.

Fixes fvwmorg#246
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:bug Something's broken!
Projects
FVWM3
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@djwf @ThomasAdam