Add an option to disable building documentation#596
Closed
aduskett wants to merge 1 commit into
Closed
Conversation
For embedded applications such as Buildroot or Yocto, the man pages may not be desired or even capable of being built. On line 45 of configure.ac there is the line: JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], [DocBook XSL Stylesheets]) There are three issues with this: - It requires building the xml-catalog package. - It automatically defaults to the host systems xml-catalog instead of the cross environments. - It isn't necessary to have a functioning firewalld. Create a new option: --disable-docs. By default, build the documentation, but if a user passes --disable-docs documentation will no longer be built as desired.
|
|
||
| if test "x$ENABLE_DOCS" = "xyes"; then | ||
| AC_CONFIG_COMMANDS([xsl-cleanup],,[rm -f doc/xml/transform-*.xsl]) | ||
| AC_CONFIG_FILES([doc/Makefile |
There was a problem hiding this comment.
As per the autoconf manual, it is indeed legit to call AC_CONFIG_FILES() multiple times:
This section describes [...] AC_CONFIG_FILES [...]
All these macros can be called multiple times, [...]
| AM_CONDITIONAL(ENABLE_DOCS, [test x$ENABLE_DOCS = xyes]) | ||
| if test "x$ENABLE_DOCS" = "xyes"; then | ||
| JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], [DocBook XSL Stylesheets]) | ||
| fi |
There was a problem hiding this comment.
If we were to try and be pedantic, this should be written as:
AS_IF([test "x$ENABLE_DOCS" = "xyes"],
[JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl],
[DocBook XSL Stylesheets])])
Collaborator
There was a problem hiding this comment.
Or use AM_COND_IF([ENABLE_DOCS], [... ])
There was a problem hiding this comment.
AM_COND_IF()
Oh, I did not know about that one, thanks! :-)
Collaborator
|
I'm working on cleaning this up manually. I'll should push it later today. |
Collaborator
|
I just pushed the changes. I had to fix it up because a few things were broken. Namely "make distclean". Thanks for the work! |
Contributor
Author
|
Thank you so much! I really appreciate your help! |
erig0
pushed a commit
that referenced
this pull request
Apr 1, 2020
For embedded applications such as Buildroot or Yocto, the man pages may not be desired or even capable of being built. On line 45 of configure.ac there is the line: JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], [DocBook XSL Stylesheets]) There are three issues with this: - It requires building the xml-catalog package. - It automatically defaults to the host systems xml-catalog instead of the cross environments. - It isn't necessary to have a functioning firewalld. Create a new option: --disable-docs. By default, build the documentation, but if a user passes --disable-docs documentation will no longer be built as desired. Fixes: #589 Closes: #596 (cherry picked from commit 1627f10)
erig0
pushed a commit
that referenced
this pull request
Apr 1, 2020
For embedded applications such as Buildroot or Yocto, the man pages may not be desired or even capable of being built. On line 45 of configure.ac there is the line: JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], [DocBook XSL Stylesheets]) There are three issues with this: - It requires building the xml-catalog package. - It automatically defaults to the host systems xml-catalog instead of the cross environments. - It isn't necessary to have a functioning firewalld. Create a new option: --disable-docs. By default, build the documentation, but if a user passes --disable-docs documentation will no longer be built as desired. Fixes: #589 Closes: #596 (cherry picked from commit 1627f10)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
For embedded applications such as Buildroot or Yocto, the man pages may not be
desired or even capable of being built.
On line 45 of configure.ac there is the line:
JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], [DocBook XSL Stylesheets])
There are three issues with this:
instead of the cross environments.
Create a new option: --disable-docs. By default, build the documentation, but
if a user passes --disable-docs documentation will no longer be built as
desired.