Skip to content

Revise doc/README - docs not built by default #247

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.

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

Merged
merged 1 commit into from
Oct 10, 2020

Conversation

djwf
Copy link
Contributor

@djwf djwf commented Oct 10, 2020

While here I reordered the mandoc/htmldoc commands so the next part (about index.html) makes more sense.

Oh, and this deals with #246.

@ThomasAdam
Copy link
Member

Hi @djwf

Thanks. This looks good to me.

Can you expand on the commit message a little tough, and add:

Fixes #xxx

To the end of the commit message so that the issue you raised is tracked? This will really help me when the changelog is generated for the next release. Make sure you replace xxx with the correct number!

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
@ThomasAdam ThomasAdam added this to the 1.0.2 milestone Oct 10, 2020
@ThomasAdam ThomasAdam self-assigned this Oct 10, 2020
@djwf
Copy link
Contributor Author

djwf commented Oct 10, 2020

Yep - clarified purpose of change and added Fixes note.

@ThomasAdam ThomasAdam merged commit df75883 into fvwmorg:master Oct 10, 2020
@ThomasAdam
Copy link
Member

Thanks @djwf - merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants