cmake: Build manual pages (curl.1 and libcurl (3) manpages)#1288
cmake: Build manual pages (curl.1 and libcurl (3) manpages)#1288Lekensteyn wants to merge 3 commits intocurl:masterfrom
Conversation
|
@Lekensteyn, thanks for your PR! By analyzing the history of the files in this pull request, we identified @billhoffman, @snikulov and @Sukender to be potential reviewers. |
3504b52 to
074c105
Compare
jay
left a comment
There was a problem hiding this comment.
Please dynamically generate those manpage filenames. I suggest doing the same thing we already do in lib and src and use transform_makefile_inc to extract the data from the appropriate Makefile.inc. This way you don't have to rely on gawk which not everyone may have. For example in lib/CMakeLists.txt there's this:
transform_makefile_inc("Makefile.inc" "${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake")
include(${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake)
To do something similar without any friction would likely require moving the filename lists such as DPAGES for example from Makefile.am into Makefile.inc, then in the Makefile.am put
# Makefile.inc provides DPAGES
include Makefile.inc
and in the Makefile.inc put
# These variables are also used by cmake to auto generate output
or something
then convert into Makefile.inc.cmake in your script
074c105 to
be426db
Compare
|
I created a new change to separate the variables and rebased the other changes on top of them. Tested with cmake only. (If another iteration is needed, I'll probably add try to move the |
|
I'd be happy to see this change land, anything still pending @Lekensteyn ? (apart from a needed rebase that is) |
|
Rebased and resolved conflicts in Makefile.am; diff --git a/docs/cmdline-opts/Makefile.inc b/docs/cmdline-opts/Makefile.inc
index 79db71119..97c0547ee 100644
--- a/docs/cmdline-opts/Makefile.inc
+++ b/docs/cmdline-opts/Makefile.inc
@@ -35,8 +35,10 @@ DPAGES = abstract-unix-socket.d anyauth.d append.d basic.d cacert.d capath.d cer
service-name.d show-error.d silent.d socks4a.d socks4.d socks5.d \
socks5-gssapi-nec.d socks5-gssapi-service.d socks5-hostname.d \
speed-limit.d speed-time.d ssl-allow-beast.d ssl.d ssl-no-revoke.d \
- ssl-reqd.d sslv2.d sslv3.d stderr.d tcp-fastopen.d tcp-nodelay.d \
+ ssl-reqd.d sslv2.d sslv3.d stderr.d suppress-connect-headers.d \
+ tcp-fastopen.d tcp-nodelay.d \
telnet-option.d tftp-blksize.d tftp-no-options.d time-cond.d \
+ tls-max.d \
tlsauthtype.d tlspassword.d tlsuser.d tlsv1.0.d tlsv1.1.d tlsv1.2.d \
tlsv1.3.d tlsv1.d trace-ascii.d trace.d trace-time.d tr-encoding.d \
unix-socket.d upload-file.d url.d use-ascii.d user-agent.d user.d \
diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc
index c8edade6a..5a201fe3f 100644
--- a/docs/libcurl/opts/Makefile.inc
+++ b/docs/libcurl/opts/Makefile.inc
@@ -278,6 +278,7 @@ man_MANS = \
CURLOPT_STREAM_DEPENDS.3 \
CURLOPT_STREAM_DEPENDS_E.3 \
CURLOPT_STREAM_WEIGHT.3 \
+ CURLOPT_SUPPRESS_CONNECT_HEADERS.3 \
CURLOPT_TCP_FASTOPEN.3 \
CURLOPT_TCP_KEEPALIVE.3 \
CURLOPT_TCP_KEEPIDLE.3 \Tested by building with cmake. TODO for later: add install targets for manpages |
bagder
left a comment
There was a problem hiding this comment.
Not a cmake person but it looks fine to me and as you tested it, I think it is fine to proceed!
|
Is that travis failure just totally bogus? I can't understand why this PR would trigger that. |
I see it also. Here is the bad section: So probably a typo diff --git a/docs/libcurl/opts/Makefile.am b/docs/libcurl/opts/Makefile.am
index 02623b6..cd9eada 100644
--- a/docs/libcurl/opts/Makefile.am
+++ b/docs/libcurl/opts/Makefile.am
@@ -23,7 +23,6 @@
AUTOMAKE_OPTIONS = foreign no-dependencies
include Makefile.inc
- CURLOPT_SUPPRESS_CONNECT_HEADERS.3 \
man_DISTMANS = $(man_MANS:.3=.3.dist) |
|
Oops, that was a merge fail. Removed that line, the other files seem OK. Attempt 2, counting on travis to do the autotools build. |
|
CI has passed. Before you push these upstream can you please add a line to the commit messages that reference this PR. For example Closes or Ref. |
For easier sharing with CMake. The contents were reformatted to use two-space indent and expanded tabs (matching lib/Makefile.common). Ref: curl#1288
Note that for some reason there is this warning (that also exists with
autotools, added since curl-7_15_1-94-ga718cb05f):
docs/libcurl/curl_multi_socket_all.3:1: can't open `man3/curl_multi_socket.3': No such file or directory
Additionally, adjust the roffit --mandir option to support creating
links when doing out-of-tree builds.
Ref: curl#1288
|
Rebased with tags added, will push when CI passed (when I am awake tomorrow). |
For easier sharing with CMake. The contents were reformatted to use two-space indent and expanded tabs (matching lib/Makefile.common). Ref: #1288
Note that for some reason there is this warning (that also exists with
autotools, added since curl-7_15_1-94-ga718cb05f):
docs/libcurl/curl_multi_socket_all.3:1: can't open `man3/curl_multi_socket.3': No such file or directory
Additionally, adjust the roffit --mandir option to support creating
links when doing out-of-tree builds.
Ref: #1288
Also make Perl mandatory to allow building the docs.
While CMakeLists.txt could probably read the list of manual pages from
Makefile.am, actually putting those in CMakeLists.txt is cleaner so that
is what is done here.
Fixes #1230
cmake: add support for building HTML and PDF docs
Note that for some reason there is this warning (that also exists with
autotools, added since curl-7_15_1-94-ga718cb05f):
Additionally, adjust the roffit --mandir option to support creating
links when doing out-of-tree builds.
(NOTE: this does not install manpages yet)