[gnurl] 207/411: tests/unit/README: convert to markdown

[gnunet]

This is an automated email from the git hooks/post-receive script.

nikita pushed a commit to branch master
in repository gnurl.

commit 8aeb82eecaef5160c67a832caaa75f89daae747c
Author: Daniel Stenberg <daniel@haxx.se>
AuthorDate: Wed Sep 30 15:12:06 2020 +0200

    tests/unit/README: convert to markdown
    
    ... and add to dist!
    
    Closes #6028
---
 tests/unit/Makefile.am           |  4 ++--
 tests/unit/{README => README.md} | 42 ++++++++++++++++------------------------
 2 files changed, 19 insertions(+), 27 deletions(-)

diff --git a/tests/unit/Makefile.am b/tests/unit/Makefile.am
index 4bcd47d22..63e11b14f 100644
--- a/tests/unit/Makefile.am
+++ b/tests/unit/Makefile.am
@@ -5,7 +5,7 @@
 #                            | (__| |_| |  _ <| |___
 #                             \___|\___/|_| \_\_____|
 #
-# Copyright (C) 1998 - 2019, 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
@@ -48,7 +48,7 @@ AM_CPPFLAGS = -I$(top_srcdir)/include        \
               -I$(top_srcdir)/tests/libtest
 endif
 
-EXTRA_DIST = Makefile.inc CMakeLists.txt
+EXTRA_DIST = Makefile.inc CMakeLists.txt README.md
 
 CFLAGS += @CURL_CFLAG_EXTRAS@
 
diff --git a/tests/unit/README b/tests/unit/README.md
similarity index 60%
rename from tests/unit/README
rename to tests/unit/README.md
index 060b670c6..2880d1979 100644
--- a/tests/unit/README
+++ b/tests/unit/README.md
@@ -1,50 +1,44 @@
-Unit tests
-==========
+# Unit tests
 
-The goal is to add tests for *ALL* functions in libcurl. If functions are too
+The goal is to add tests for *all* functions in libcurl. If functions are too
 big and complicated, we should split them into smaller and testable ones.
 
-Build Unit Tests
-================
+## Build Unit Tests
 
-'./configure --enable-debug' is required for the unit tests to build. To
+`./configure --enable-debug` is required for the unit tests to build. To
 enable unit tests, there will be a separate static libcurl built that will be
 used exclusively for linking unit test programs. Just build everything as
 normal, and then you can run the unit test cases as well.
 
-Run Unit Tests
-==============
+## Run Unit Tests
 
 Unit tests are run as part of the regular test suite. If you have built
 everything to run unit tests, to can do 'make test' at the root level. Or you
-can 'cd tests' and 'make' and then invoke individual unit tests with
-./runtests.pl NNNN where NNNN is the specific test number.
+can `cd tests` and `make` and then invoke individual unit tests with
+`./runtests.pl NNNN` where `NNNN` is the specific test number.
 
-Debug Unit Tests
-================
+## Debug Unit Tests
 
 If a specific test fails you will get told. The test case then has output left
 in the log/ subdirectory, but most importantly you can re-run the test again
-using gdb by doing ./runtests.pl -g NNNN. That is, add a -g to make it start
-up gdb and run the same case using that.
+using gdb by doing `./runtests.pl -g NNNN`. That is, add a `-g` to make it
+start up gdb and run the same case using that.
 
-Write Unit Tests
-================
+## Write Unit Tests
 
 We put tests that focus on an area or a specific function into a single C
 source file. The source file should be named 'unitNNNN.c' where NNNN is a
-number that starts with 1300 and you can pick the next free number.
+previously unused number.
 
-Add your test to tests/unit/Makefile.inc (if it is a unit test).
-Add your test data to tests/data/Makefile.inc
+Add your test to `tests/unit/Makefile.inc` (if it is a unit test).  Add your
+test data file name to `tests/data/Makefile.inc`
 
-You also need a separate file called tests/data/testNNNN (using the same
+You also need a separate file called `tests/data/testNNNN` (using the same
 number) that describes your test case. See the test1300 file for inspiration
-and the tests/FILEFORMAT documentation.
+and the `tests/FILEFORMAT.md` documentation.
 
 For the actual C file, here's a very simple example:
-
------------------------ start -------------------------------
+~~~c
 #include "curlcheck.h"
 
 #include "a libcurl header.h" /* from the lib dir */
@@ -70,5 +64,3 @@ UNITTEST_START
   /* you end the test code like this: */
 
 UNITTEST_STOP
-
------------------------ end -------------------------------

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.