]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
ABI.md: rename to .md and polish the markdown
authorDaniel Stenberg <daniel@haxx.se>
Fri, 12 Jun 2020 11:26:20 +0000 (13:26 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 12 Jun 2020 15:05:21 +0000 (17:05 +0200)
Closes #5562

docs/libcurl/ABI.md [moved from docs/libcurl/ABI with 84% similarity]
docs/libcurl/Makefile.am

similarity index 84%
rename from docs/libcurl/ABI
rename to docs/libcurl/ABI.md
index c7c914202e887c6f1cc6c903871010e8e84771fd..39134a1ae2d19aef211083a5da770db19aaf69e6 100644 (file)
@@ -7,8 +7,7 @@ ABI - Application Binary Interface
 
  [Wikipedia has a longer description](https://en.wikipedia.org/wiki/Application_binary_interface)
 
-Upgrades
---------
+## Upgrades
 
  In the vast majority of all cases, a typical libcurl upgrade does not break
  the ABI at all. Your application can remain using libcurl just as before,
@@ -17,14 +16,12 @@ Upgrades
  to verify that your application still builds fine and uses libcurl as it now
  is defined to work.
 
-Version Numbers
----------------
+## Version Numbers
 
  In libcurl land, you really can't tell by the libcurl version number if that
  libcurl is binary compatible or not with another libcurl version.
 
-Soname Bumps
-------------
+## Soname Bumps
 
  Whenever there are changes done to the library that will cause an ABI
  breakage, that may require your application to get attention or possibly be
@@ -40,8 +37,7 @@ Soname Bumps
  We are determined to bump the SONAME as rarely as possible.  Ideally, we
  never do it again.
 
-Downgrades
-----------
+## Downgrades
 
  Going to an older libcurl version from one you're currently using can be a
  tricky thing. Mostly we add features and options to newer libcurls as that
@@ -51,18 +47,17 @@ Downgrades
  downgrade so far so you cross an ABI break border and thus a different
  soname, and then your application may need to adapt to the modified ABI.
 
-History
--------
+## History
 
 The previous major library soname number bumps (breaking backwards
 compatibility) have happened the following times:
+ The previous major library soname number bumps (breaking backwards
+ compatibility) have happened the following times:
 
 0 - libcurl 7.1,   August 2000
+ 0 - libcurl 7.1,   August 2000
 
 1 - libcurl 7.5    December 2000
+ 1 - libcurl 7.5    December 2000
 
 2 - libcurl 7.7    March 2001
+ 2 - libcurl 7.7    March 2001
 
 3 - libcurl 7.12.0 June 2004
+ 3 - libcurl 7.12.0 June 2004
 
 4 - libcurl 7.16.0 October 2006
+ 4 - libcurl 7.16.0 October 2006
index 041f02ea4ad085c1a32c3ccbfa9b6402f11b1abe..8681dbdfb2a08d57abc88004d4a85ae20432b94f 100644 (file)
@@ -5,7 +5,7 @@
 #                            | (__| |_| |  _ <| |___
 #                             \___|\___/|_| \_\_____|
 #
-# Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
+# Copyright (C) 1998 - 2020, 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
@@ -38,7 +38,7 @@ dist_m4macro_DATA = libcurl.m4
 CLEANFILES = $(HTMLPAGES) $(PDFPAGES) $(TESTS) $(man_DISTMANS) \
   libcurl-symbols.3
 
-EXTRA_DIST = $(man_MANS) ABI symbols-in-versions symbols.pl  \
+EXTRA_DIST = $(man_MANS) ABI.md symbols-in-versions symbols.pl  \
   mksymbolsmanpage.pl CMakeLists.txt
 MAN2HTML= roffit --mandir=. $< >$@