[DOC] Link Check

Author: eseiler

doc/about/api/index.md

@@ -38,10 +38,10 @@ this should not be a problem.
 We promise to support the above compilers in the latest release of Sharg, or until all the following
 operating systems provide a newer supported compiler:
 
-| Operating System             | Supported Releases¹                    |
+| Operating System             | Supported Releases                     |
 |------------------------------|----------------------------------------|
-| RedHat Enterprise Linux      | the latest release ²                   |
-| CentOS Linux                 | the latest release ²                   |
+| RedHat Enterprise Linux      | the latest release ¹                   |
+| CentOS Linux                 | the latest release ¹                   |
 | SUSE Linux Enterprise Server | the latest release                     |
 | Debian GNU/Linux             | "stable" and "old-stable"              |
 | Ubuntu Linux                 | the two latest LTS releases            |
@@ -58,9 +58,7 @@ third party services.
 **We promise to provide good forward-compatibility with the C++ standard.** And we will strive to fix any warnings that
 are added by newer versions of a supported compiler.
 
-<small>¹ [This site](https://linuxlifecycle.com) provides a good overview of what the current release and its
-lifecycle is.</small><br>
-<small>² We consider CentOS 7 / RedHat Enterprise Linux (RHEL) 7 as being community-supported. That means issues and
+<small>¹ We consider CentOS 7 / RedHat Enterprise Linux (RHEL) 7 as being community-supported. That means issues and
 patches are welcome, but we do not actively test for those operating systems. See this related
 [issue](https://github.com/seqan/seqan3/issues/2244).</small>
 

test/external_project/CMakeLists.txt

@@ -49,7 +49,7 @@ ExternalProject_Add (
 #    This test assumes that `sharg-config.cmake` can be found by cmake in some global paths like /usr/share/cmake/.
 #
 #    We simulate this by using our `make package` release, e.g. the one we release under
-#    https://github.com/seqan/sharg/releases, and unzipping it to some folder and making
+#    https://github.com/seqan/sharg-parser/releases, and unzipping it to some folder and making
 #    that path globally accessible by CMAKE_SYSTEM_PREFIX_PATH.
 # (ExternalProject_Add simulates a fresh and separate invocation of cmake ../)
 ExternalProject_Add (
@@ -64,7 +64,7 @@ add_dependencies (sharg_installed sharg_test_prerequisite)
 
 # 4) This tests test/external_project/sharg_fetch_content_zip/CMakeLists.txt
 #    It uses fetch_content (a CMake 3.14 feature) to download our zip-release (e.g. zip, tar.xz) from
-#    https://github.com/seqan/sharg/releases. fetch_content will automatically download, verify, extract it.
+#    https://github.com/seqan/sharg-parser/releases. fetch_content will automatically download, verify, extract it.
 #    The user only needs to define CMAKE_PREFIX_PATH to be able to find our `sharg-config.cmake`.
 #    Note that FetchContent is a CMake >= 3.14 feature.
 #    This is expected to work with CMake >= 3.14.

test/scripts/link_check.sh

@@ -12,27 +12,30 @@
 # The general workflow is to first run the script and then check the non-working links by searching the occurrence
 # within the codebase and verifying that they are indeed broken.
 
+COUNT=0
 do_check ()
 {
-    RESPONSE=$(curl --http2 -Is -A 'Mozilla/5.0' $1) # HTTP2 is the default.
-    if ! [[ "$RESPONSE" =~ ^HTTP.* ]]; then # If this does not work,
-        RESPONSE=$(curl --http1.1 -Is -A 'Mozilla/5.0' $1) # fall back to HTTP1.1.
+    (( COUNT++ ))
+    RESPONSE=$(curl --http2 -Is -A 'Mozilla/5.0' "$1") # HTTP2 is the default.
+    if ! [[ "${RESPONSE}" =~ ^HTTP.* ]]; then # If this does not work,
+        RESPONSE=$(curl --http1.1 -Is -A 'Mozilla/5.0' "$1") # fall back to HTTP1.1.
     fi
 
-    HEADER=($(echo $RESPONSE | head -1)); # May look like: HTTP/2 200
+    HEADER=($(echo "${RESPONSE}" | head -1)); # May look like: HTTP/2 200
     STATUS=${HEADER[1]}
+    echo -n "[${COUNT}] "
     case "$STATUS" in
-        200) echo "Link OK         :" $1;;
-        301) echo "Link PERM MOVED :" $1;;
-        302) echo "Link TEMP MOVED :" $1;;
-        404) echo "Link BROKE      :" $1;;
-        429) sleep 5; do_check $1;;
-        *)   echo "Link STATUS" $STATUS ":" $1;;
+        200) echo "Link OK         : $1";;
+        301) echo "Link PERM MOVED : $1";;
+        302) echo "Link TEMP MOVED : $1";;
+        404) echo "Link BROKE      : $1";;
+        429) sleep 5; do_check "$1";;
+        *)   echo "Link STATUS ${STATUS} : $1";;
     esac
 }
 
-if [[ $# -ne 1 ]]; then
-    echo "Usage: link_check.sh <Sharg root directory>"
+if [[ $# -ne 1 ]] && [[ $# -ne 2 ]]; then
+    echo "Usage: link_check.sh <Sharg root directory> <Skip first n=0 entries>"
     exit 1
 fi
 
@@ -47,7 +50,10 @@ if [[ ! -f $1/include/sharg/version.hpp ]]; then
     exit 1
 fi
 
-for URL in $(grep -ohr --exclude-dir={.git,submodules,build} "https*://[a-zA-Z0-9./#+?=_%:-]*[a-zA-Z0-9/#+?=_%:-]" $1 | sort | uniq)
+SKIP="${2:-0}"
+COUNT=$((COUNT + SKIP))
+
+for URL in $(grep -ohr --exclude-dir={.git,.vscode,build} "https*://[a-zA-Z0-9./#+?=_%:-]*[a-zA-Z0-9/#+?=_%:-]" "$1" | sort | uniq | tail -n +"${SKIP}")
 do
-  do_check $URL
+  do_check "${URL}"
 done