diff options
| -rw-r--r-- | docs/libcurl/Makefile.am | 14 | ||||
| -rw-r--r-- | docs/libcurl/mksymbolsmanpage.pl | 72 |
2 files changed, 81 insertions, 5 deletions
diff --git a/docs/libcurl/Makefile.am b/docs/libcurl/Makefile.am index c47678b43..00ef3c517 100644 --- a/docs/libcurl/Makefile.am +++ b/docs/libcurl/Makefile.am @@ -5,7 +5,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -40,7 +40,7 @@ man_MANS = curl_easy_cleanup.3 curl_easy_getinfo.3 curl_easy_init.3 \ curl_easy_unescape.3 curl_multi_setopt.3 curl_multi_socket.3 \ curl_multi_timeout.3 curl_formget.3 curl_multi_assign.3 \ curl_easy_pause.3 curl_easy_recv.3 curl_easy_send.3 \ - curl_multi_socket_action.3 curl_multi_wait.3 + curl_multi_socket_action.3 curl_multi_wait.3 libcurl-symbols.3 HTMLPAGES = curl_easy_cleanup.html curl_easy_getinfo.html \ curl_easy_init.html curl_easy_perform.html curl_easy_setopt.html \ @@ -60,7 +60,7 @@ HTMLPAGES = curl_easy_cleanup.html curl_easy_getinfo.html \ curl_easy_unescape.html curl_multi_setopt.html curl_multi_socket.html \ curl_multi_timeout.html curl_formget.html curl_multi_assign.html \ curl_easy_pause.html curl_easy_recv.html curl_easy_send.html \ - curl_multi_socket_action.html curl_multi_wait.html + curl_multi_socket_action.html curl_multi_wait.html libcurl-symbols.html PDFPAGES = curl_easy_cleanup.pdf curl_easy_getinfo.pdf \ curl_easy_init.pdf curl_easy_perform.pdf curl_easy_setopt.pdf \ @@ -79,7 +79,8 @@ PDFPAGES = curl_easy_cleanup.pdf curl_easy_getinfo.pdf \ curl_easy_escape.pdf curl_easy_unescape.pdf curl_multi_setopt.pdf \ curl_multi_socket.pdf curl_multi_timeout.pdf curl_formget.pdf \ curl_multi_assign.pdf curl_easy_pause.pdf curl_easy_recv.pdf \ - curl_easy_send.pdf curl_multi_socket_action.pdf curl_multi_wait.pdf + curl_easy_send.pdf curl_multi_socket_action.pdf curl_multi_wait.pdf \ + libcurl-symbols.pdf m4macrodir = $(datadir)/aclocal dist_m4macro_DATA = libcurl.m4 @@ -87,11 +88,14 @@ dist_m4macro_DATA = libcurl.m4 CLEANFILES = $(HTMLPAGES) $(PDFPAGES) EXTRA_DIST = $(man_MANS) $(HTMLPAGES) index.html $(PDFPAGES) ABI \ - symbols-in-versions symbols.pl + symbols-in-versions symbols.pl mksymbolsmanpage.pl MAN2HTML= roffit --mandir=. < $< >$@ SUFFIXES = .3 .html +libcurl-symbols.3: $(srcdir)/symbols-in-versions $(srcdir)/mksymbolsmanpage.pl + perl $(srcdir)/mksymbolsmanpage.pl < $< > $@ + html: $(HTMLPAGES) cd opts; make html diff --git a/docs/libcurl/mksymbolsmanpage.pl b/docs/libcurl/mksymbolsmanpage.pl new file mode 100644 index 000000000..918ef4e29 --- /dev/null +++ b/docs/libcurl/mksymbolsmanpage.pl @@ -0,0 +1,72 @@ +#!/usr/bin/perl + +my $version="7.41.0"; + +use POSIX qw(strftime); +my $date = strftime "%b %e, %Y", localtime; +my $year = strftime "%Y", localtime; + +print <<HEADER +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - $year, Daniel Stenberg, <daniel\@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.TH libcurl-symbols 3 "$date" "libcurl $version" "libcurl symbols" +.SH NAME +libcurl-symbols \- libcurl symbol version information +.SH "libcurl symbols" +This man page details version information for public symbols provided in the +libcurl header files. This lists the first version in which the symbol was +introduced and for some symbols two additional information pieces: + +The first version in which the symbol is marked "deprecated" - meaning that +since that version no new code should be written to use the symbol as it is +marked for getting removed in a future. + +The last version that featured the specific symbol. Using the symbol in source +code will make it no longer compile error-free after that specified version. + +This man page is automatically generated from the symbols-in-versions file. +HEADER + ; + +while(<STDIN>) { + if($_ =~ /^(CURL[A-Z0-9_.]*) *(.*)/) { + my ($symbol, $rest)=($1,$2); + my ($intro, $dep, $rem); + if($rest =~ s/^([0-9.]*) *//) { + $intro = $1; + } + if($rest =~ s/^([0-9.]*) *//) { + $dep = $1; + } + if($rest =~ s/^([0-9.]*) *//) { + $rem = $1; + } + print ".IP $symbol\nIntroduced in $intro\n"; + if($dep) { + print "Deprecated since $dep\n"; + } + if($rem) { + print "Last used in $dep\n"; + } + } + +} |