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.

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

Add configure option to generate html man pages. #920

Merged
merged 2 commits into from
Oct 29, 2023
Merged

Conversation

somiaj
Copy link
Collaborator

@somiaj somiaj commented Oct 24, 2023

./configure --enable-htmldoc will now use asciidoctor to build and then install .html versions of the manual pages (with a table of contents) in $FVWM_DATADIR/htmldoc.

  ./configure --enable-htmldoc will now use asciidoctor to build
  and then install .html versions of the manual pages (with a
  table of contents) in $FVWM_DATADIR/htmldoc.
configure.ac Outdated
elif test x"$SED" = x ; then
with_htmldoc="no"
problem_htmldoc=": No sed found in PATH"
elif test x"$HAVE_PERL_FOR_DOCS" = x0 ; then
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this check necessary?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just copied the manpage checks, but the second commit removes these perl checks, since the POD is no longer being used.

@ThomasAdam
Copy link
Member

Hi @somiaj

Thanks for this -- things looks OK to me. Just not sure about the $SED check. There's perhaps one or two style cleanups I'd recommend, but nothing blocking this to be merged, IMO.

If you can just clarify the $SED point, I'll probably merge it later.

@ThomasAdam ThomasAdam added type:enhancement Augmenting an existing feature area:doc Relates to documentation only labels Oct 28, 2023
  * Convert bin/fvwm-menu-directory.1, bin/fvwm-perllib.1,
    and bin/fvwm-menu-xlock.1 to asciidoc files in doc/
    so they can be built into html files.
  * Add a comment in the POD that the man pages have moved
    (though the man pages haven't been generated from the pod since 2009).
  * Remove the perl check in the --enable-mandoc and --enable-htmldoc
    options, since perl isn't used to build the docs.
  * Remove sed checks as well, since SED is no longer used in either
    manpage or htmldoc creation.
@ThomasAdam ThomasAdam added this to the 1.0.9 milestone Oct 28, 2023
@somiaj
Copy link
Collaborator Author

somiaj commented Oct 28, 2023

Oh you were talking about the SED check. I removed them for both htmldoc and manpages, I don't see sed being used for either.

@ThomasAdam ThomasAdam merged commit e8432f5 into main Oct 29, 2023
5 checks passed
@ThomasAdam ThomasAdam deleted the js/html-man-pages branch October 29, 2023 00:35
@ThomasAdam
Copy link
Member

Thanks! All merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:doc Relates to documentation only type:enhancement Augmenting an existing feature
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants